databricks.RfaAccessRequestDestinations
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
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
customerDataTable:
type: databricks:RfaAccessRequestDestinations
name: customer_data_table
properties:
destinations:
- destination_id: john.doe@databricks.com
destination_type: EMAIL
- destination_id: https://www.databricks.com/
destination_type: URL
- destination_id: 456e7890-e89b-12d3-a456-426614174001
destination_type: SLACK
- destination_id: 789e0123-e89b-12d3-a456-426614174002
destination_type: MICROSOFT_TEAMS
- destination_id: 012e3456-e89b-12d3-a456-426614174003
destination_type: GENERIC_WEBHOOK
securable:
type: SCHEMA
full_name: main.customer_data
areAnyDestinationsHidden: false
Create RfaAccessRequestDestinations Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RfaAccessRequestDestinations(name: string, args: RfaAccessRequestDestinationsArgs, opts?: CustomResourceOptions);@overload
def RfaAccessRequestDestinations(resource_name: str,
args: RfaAccessRequestDestinationsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RfaAccessRequestDestinations(resource_name: str,
opts: Optional[ResourceOptions] = None,
destinations: Optional[Sequence[RfaAccessRequestDestinationsDestinationArgs]] = None,
securable: Optional[RfaAccessRequestDestinationsSecurableArgs] = None)func NewRfaAccessRequestDestinations(ctx *Context, name string, args RfaAccessRequestDestinationsArgs, opts ...ResourceOption) (*RfaAccessRequestDestinations, error)public RfaAccessRequestDestinations(string name, RfaAccessRequestDestinationsArgs args, CustomResourceOptions? opts = null)
public RfaAccessRequestDestinations(String name, RfaAccessRequestDestinationsArgs args)
public RfaAccessRequestDestinations(String name, RfaAccessRequestDestinationsArgs args, CustomResourceOptions options)
type: databricks:RfaAccessRequestDestinations
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 RfaAccessRequestDestinationsArgs
- 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 RfaAccessRequestDestinationsArgs
- 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 RfaAccessRequestDestinationsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RfaAccessRequestDestinationsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RfaAccessRequestDestinationsArgs
- 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 rfaAccessRequestDestinationsResource = new Databricks.RfaAccessRequestDestinations("rfaAccessRequestDestinationsResource", new()
{
Destinations = new[]
{
new Databricks.Inputs.RfaAccessRequestDestinationsDestinationArgs
{
DestinationId = "string",
DestinationType = "string",
SpecialDestination = "string",
},
},
Securable = new Databricks.Inputs.RfaAccessRequestDestinationsSecurableArgs
{
FullName = "string",
ProviderShare = "string",
Type = "string",
},
});
example, err := databricks.NewRfaAccessRequestDestinations(ctx, "rfaAccessRequestDestinationsResource", &databricks.RfaAccessRequestDestinationsArgs{
Destinations: databricks.RfaAccessRequestDestinationsDestinationArray{
&databricks.RfaAccessRequestDestinationsDestinationArgs{
DestinationId: pulumi.String("string"),
DestinationType: pulumi.String("string"),
SpecialDestination: pulumi.String("string"),
},
},
Securable: &databricks.RfaAccessRequestDestinationsSecurableArgs{
FullName: pulumi.String("string"),
ProviderShare: pulumi.String("string"),
Type: pulumi.String("string"),
},
})
var rfaAccessRequestDestinationsResource = new RfaAccessRequestDestinations("rfaAccessRequestDestinationsResource", RfaAccessRequestDestinationsArgs.builder()
.destinations(RfaAccessRequestDestinationsDestinationArgs.builder()
.destinationId("string")
.destinationType("string")
.specialDestination("string")
.build())
.securable(RfaAccessRequestDestinationsSecurableArgs.builder()
.fullName("string")
.providerShare("string")
.type("string")
.build())
.build());
rfa_access_request_destinations_resource = databricks.RfaAccessRequestDestinations("rfaAccessRequestDestinationsResource",
destinations=[{
"destination_id": "string",
"destination_type": "string",
"special_destination": "string",
}],
securable={
"full_name": "string",
"provider_share": "string",
"type": "string",
})
const rfaAccessRequestDestinationsResource = new databricks.RfaAccessRequestDestinations("rfaAccessRequestDestinationsResource", {
destinations: [{
destinationId: "string",
destinationType: "string",
specialDestination: "string",
}],
securable: {
fullName: "string",
providerShare: "string",
type: "string",
},
});
type: databricks:RfaAccessRequestDestinations
properties:
destinations:
- destinationId: string
destinationType: string
specialDestination: string
securable:
fullName: string
providerShare: string
type: string
RfaAccessRequestDestinations 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 RfaAccessRequestDestinations resource accepts the following input properties:
- Destinations
List<Rfa
Access Request Destinations Destination> - The access request destinations for the securable
- Securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- Destinations
[]Rfa
Access Request Destinations Destination Args - The access request destinations for the securable
- Securable
Rfa
Access Request Destinations Securable Args - The securable for which the access request destinations are being retrieved
- destinations
List<Rfa
Access Request Destinations Destination> - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- destinations
Rfa
Access Request Destinations Destination[] - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- destinations
Sequence[Rfa
Access Request Destinations Destination Args] - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable Args - The securable for which the access request destinations are being retrieved
- destinations List<Property Map>
- The access request destinations for the securable
- securable Property Map
- The securable for which the access request destinations are being retrieved
Outputs
All input properties are implicitly available as output properties. Additionally, the RfaAccessRequestDestinations resource produces the following output properties:
- bool
- (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
- Id string
- The provider-assigned unique ID for this managed resource.
- bool
- (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
- Id string
- The provider-assigned unique ID for this managed resource.
- Boolean
- (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
- id String
- The provider-assigned unique ID for this managed resource.
- boolean
- (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
- id string
- The provider-assigned unique ID for this managed resource.
- bool
- (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
- id str
- The provider-assigned unique ID for this managed resource.
- Boolean
- (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
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing RfaAccessRequestDestinations Resource
Get an existing RfaAccessRequestDestinations 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?: RfaAccessRequestDestinationsState, opts?: CustomResourceOptions): RfaAccessRequestDestinations@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
are_any_destinations_hidden: Optional[bool] = None,
destinations: Optional[Sequence[RfaAccessRequestDestinationsDestinationArgs]] = None,
securable: Optional[RfaAccessRequestDestinationsSecurableArgs] = None) -> RfaAccessRequestDestinationsfunc GetRfaAccessRequestDestinations(ctx *Context, name string, id IDInput, state *RfaAccessRequestDestinationsState, opts ...ResourceOption) (*RfaAccessRequestDestinations, error)public static RfaAccessRequestDestinations Get(string name, Input<string> id, RfaAccessRequestDestinationsState? state, CustomResourceOptions? opts = null)public static RfaAccessRequestDestinations get(String name, Output<String> id, RfaAccessRequestDestinationsState state, CustomResourceOptions options)resources: _: type: databricks:RfaAccessRequestDestinations 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.
- bool
- (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
- Destinations
List<Rfa
Access Request Destinations Destination> - The access request destinations for the securable
- Securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- bool
- (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
- Destinations
[]Rfa
Access Request Destinations Destination Args - The access request destinations for the securable
- Securable
Rfa
Access Request Destinations Securable Args - The securable for which the access request destinations are being retrieved
- Boolean
- (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
- destinations
List<Rfa
Access Request Destinations Destination> - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- boolean
- (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
- destinations
Rfa
Access Request Destinations Destination[] - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable - The securable for which the access request destinations are being retrieved
- bool
- (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
- destinations
Sequence[Rfa
Access Request Destinations Destination Args] - The access request destinations for the securable
- securable
Rfa
Access Request Destinations Securable Args - The securable for which the access request destinations are being retrieved
- Boolean
- (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
- destinations List<Property Map>
- The access request destinations for the securable
- securable Property Map
- The securable for which the access request destinations are being retrieved
Supporting Types
RfaAccessRequestDestinationsDestination, RfaAccessRequestDestinationsDestinationArgs
- Destination
Id string - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- Destination
Type string - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - Special
Destination string - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
- Destination
Id string - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- Destination
Type string - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - Special
Destination string - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
- destination
Id String - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- destination
Type String - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - special
Destination String - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
- destination
Id string - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- destination
Type string - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - special
Destination string - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
- destination_
id str - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- destination_
type str - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - special_
destination str - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
- destination
Id String - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations
- destination
Type String - The type of the destination. Possible values are:
EMAIL,GENERIC_WEBHOOK,MICROSOFT_TEAMS,SLACK,URL - special
Destination String - This field is used to denote whether the destination is the email of the owner of the securable object.
The special destination cannot be assigned to a securable and only represents the default destination of the securable.
The securable types that support default special destinations are: "catalog", <span pulumi-lang-nodejs=""externalLocation"" pulumi-lang-dotnet=""ExternalLocation"" pulumi-lang-go=""externalLocation"" pulumi-lang-python=""external_location"" pulumi-lang-yaml=""externalLocation"" pulumi-lang-java=""externalLocation"">"external_location", "connection", "credential", and "metastore".
The destination_type of a special_destination is always EMAIL. Possible values are:
SPECIAL_DESTINATION_CATALOG_OWNER,SPECIAL_DESTINATION_CONNECTION_OWNER,SPECIAL_DESTINATION_CREDENTIAL_OWNER,SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER,SPECIAL_DESTINATION_METASTORE_OWNER
RfaAccessRequestDestinationsSecurable, RfaAccessRequestDestinationsSecurableArgs
- Full
Name string - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- string
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- Type string
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
- Full
Name string - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- string
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- Type string
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
- full
Name String - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- String
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- type String
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
- full
Name string - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- string
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- type string
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
- full_
name str - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- str
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- type str
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
- full
Name String - Required. The full name of the catalog/schema/table. Optional if resource_name is present
- String
- Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing
- type String
- Required. The type of securable (catalog/schema/table).
Optional if resource_name is present. Possible values are:
CATALOG,CLEAN_ROOM,CONNECTION,CREDENTIAL,EXTERNAL_LOCATION,EXTERNAL_METADATA,FUNCTION,METASTORE,PIPELINE,PROVIDER,RECIPIENT,SCHEMA,SHARE,STAGING_TABLE,STORAGE_CREDENTIAL,TABLE,VOLUME
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:
$ pulumi import databricks:index/rfaAccessRequestDestinations:RfaAccessRequestDestinations this ""
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
databricksTerraform Provider.
