Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. AibiDashboardEmbeddingAccessPolicySetting
Databricks v1.65.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.AibiDashboardEmbeddingAccessPolicySetting

Explore with Pulumi AI

Databricks v1.65.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-databricks

This resource can only be used with a workspace-level provider!

The databricks.AibiDashboardEmbeddingAccessPolicySetting resource allows you to control embedding of AI/BI Dashboards into other sites.

Example Usage

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

const _this = new databricks.AibiDashboardEmbeddingAccessPolicySetting("this", {aibiDashboardEmbeddingAccessPolicy: {
    accessPolicyType: "ALLOW_APPROVED_DOMAINS",
}});
Copy
import pulumi
import pulumi_databricks as databricks

this = databricks.AibiDashboardEmbeddingAccessPolicySetting("this", aibi_dashboard_embedding_access_policy={
    "access_policy_type": "ALLOW_APPROVED_DOMAINS",
})
Copy
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 {
		_, err := databricks.NewAibiDashboardEmbeddingAccessPolicySetting(ctx, "this", &databricks.AibiDashboardEmbeddingAccessPolicySettingArgs{
			AibiDashboardEmbeddingAccessPolicy: &databricks.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs{
				AccessPolicyType: pulumi.String("ALLOW_APPROVED_DOMAINS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.AibiDashboardEmbeddingAccessPolicySetting("this", new()
    {
        AibiDashboardEmbeddingAccessPolicy = new Databricks.Inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs
        {
            AccessPolicyType = "ALLOW_APPROVED_DOMAINS",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySetting;
import com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySettingArgs;
import com.pulumi.databricks.inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs;
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 this_ = new AibiDashboardEmbeddingAccessPolicySetting("this", AibiDashboardEmbeddingAccessPolicySettingArgs.builder()
            .aibiDashboardEmbeddingAccessPolicy(AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs.builder()
                .accessPolicyType("ALLOW_APPROVED_DOMAINS")
                .build())
            .build());

    }
}
Copy
resources:
  this:
    type: databricks:AibiDashboardEmbeddingAccessPolicySetting
    properties:
      aibiDashboardEmbeddingAccessPolicy:
        accessPolicyType: ALLOW_APPROVED_DOMAINS
Copy

The following resources are often used in the same context:

  • databricks.AibiDashboardEmbeddingApprovedDomainsSetting is used to control approved domains.

Create AibiDashboardEmbeddingAccessPolicySetting Resource

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

Constructor syntax

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

@overload
def AibiDashboardEmbeddingAccessPolicySetting(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              aibi_dashboard_embedding_access_policy: Optional[AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs] = None,
                                              etag: Optional[str] = None,
                                              setting_name: Optional[str] = None)
func NewAibiDashboardEmbeddingAccessPolicySetting(ctx *Context, name string, args AibiDashboardEmbeddingAccessPolicySettingArgs, opts ...ResourceOption) (*AibiDashboardEmbeddingAccessPolicySetting, error)
public AibiDashboardEmbeddingAccessPolicySetting(string name, AibiDashboardEmbeddingAccessPolicySettingArgs args, CustomResourceOptions? opts = null)
public AibiDashboardEmbeddingAccessPolicySetting(String name, AibiDashboardEmbeddingAccessPolicySettingArgs args)
public AibiDashboardEmbeddingAccessPolicySetting(String name, AibiDashboardEmbeddingAccessPolicySettingArgs args, CustomResourceOptions options)

type: databricks:AibiDashboardEmbeddingAccessPolicySetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AibiDashboardEmbeddingAccessPolicySettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AibiDashboardEmbeddingAccessPolicySettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AibiDashboardEmbeddingAccessPolicySettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AibiDashboardEmbeddingAccessPolicySettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AibiDashboardEmbeddingAccessPolicySettingArgs
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 aibiDashboardEmbeddingAccessPolicySettingResource = new Databricks.AibiDashboardEmbeddingAccessPolicySetting("aibiDashboardEmbeddingAccessPolicySettingResource", new()
{
    AibiDashboardEmbeddingAccessPolicy = new Databricks.Inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs
    {
        AccessPolicyType = "string",
    },
    Etag = "string",
    SettingName = "string",
});
Copy
example, err := databricks.NewAibiDashboardEmbeddingAccessPolicySetting(ctx, "aibiDashboardEmbeddingAccessPolicySettingResource", &databricks.AibiDashboardEmbeddingAccessPolicySettingArgs{
	AibiDashboardEmbeddingAccessPolicy: &databricks.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs{
		AccessPolicyType: pulumi.String("string"),
	},
	Etag:        pulumi.String("string"),
	SettingName: pulumi.String("string"),
})
Copy
var aibiDashboardEmbeddingAccessPolicySettingResource = new AibiDashboardEmbeddingAccessPolicySetting("aibiDashboardEmbeddingAccessPolicySettingResource", AibiDashboardEmbeddingAccessPolicySettingArgs.builder()
    .aibiDashboardEmbeddingAccessPolicy(AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs.builder()
        .accessPolicyType("string")
        .build())
    .etag("string")
    .settingName("string")
    .build());
Copy
aibi_dashboard_embedding_access_policy_setting_resource = databricks.AibiDashboardEmbeddingAccessPolicySetting("aibiDashboardEmbeddingAccessPolicySettingResource",
    aibi_dashboard_embedding_access_policy={
        "access_policy_type": "string",
    },
    etag="string",
    setting_name="string")
Copy
const aibiDashboardEmbeddingAccessPolicySettingResource = new databricks.AibiDashboardEmbeddingAccessPolicySetting("aibiDashboardEmbeddingAccessPolicySettingResource", {
    aibiDashboardEmbeddingAccessPolicy: {
        accessPolicyType: "string",
    },
    etag: "string",
    settingName: "string",
});
Copy
type: databricks:AibiDashboardEmbeddingAccessPolicySetting
properties:
    aibiDashboardEmbeddingAccessPolicy:
        accessPolicyType: string
    etag: string
    settingName: string
Copy

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

aibiDashboardEmbeddingAccessPolicy This property is required. Property Map
block with following attributes:
etag String
settingName String

Outputs

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

Get an existing AibiDashboardEmbeddingAccessPolicySetting 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?: AibiDashboardEmbeddingAccessPolicySettingState, opts?: CustomResourceOptions): AibiDashboardEmbeddingAccessPolicySetting
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aibi_dashboard_embedding_access_policy: Optional[AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs] = None,
        etag: Optional[str] = None,
        setting_name: Optional[str] = None) -> AibiDashboardEmbeddingAccessPolicySetting
func GetAibiDashboardEmbeddingAccessPolicySetting(ctx *Context, name string, id IDInput, state *AibiDashboardEmbeddingAccessPolicySettingState, opts ...ResourceOption) (*AibiDashboardEmbeddingAccessPolicySetting, error)
public static AibiDashboardEmbeddingAccessPolicySetting Get(string name, Input<string> id, AibiDashboardEmbeddingAccessPolicySettingState? state, CustomResourceOptions? opts = null)
public static AibiDashboardEmbeddingAccessPolicySetting get(String name, Output<String> id, AibiDashboardEmbeddingAccessPolicySettingState state, CustomResourceOptions options)
resources:  _:    type: databricks:AibiDashboardEmbeddingAccessPolicySetting    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
aibiDashboardEmbeddingAccessPolicy Property Map
block with following attributes:
etag String
settingName String

Supporting Types

AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy
, AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs

AccessPolicyType This property is required. string
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.
AccessPolicyType This property is required. string
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.
accessPolicyType This property is required. String
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.
accessPolicyType This property is required. string
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.
access_policy_type This property is required. str
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.
accessPolicyType This property is required. String
Configured embedding policy. Possible values are ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS.

Import

This resource can be imported by predefined name global:

bash

$ pulumi import databricks:index/aibiDashboardEmbeddingAccessPolicySetting:AibiDashboardEmbeddingAccessPolicySetting this global
Copy

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 v1.65.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-databricks