Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. AibiDashboardEmbeddingApprovedDomainsSetting
Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.AibiDashboardEmbeddingApprovedDomainsSetting

Explore with Pulumi AI

Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

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

The databricks.AibiDashboardEmbeddingApprovedDomainsSetting resource allows you to specify the list of domains allowed for 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",
}});
const thisAibiDashboardEmbeddingApprovedDomainsSetting = new databricks.AibiDashboardEmbeddingApprovedDomainsSetting("this", {aibiDashboardEmbeddingApprovedDomains: {
    approvedDomains: ["test.com"],
}}, {
    dependsOn: [_this],
});
Copy
import pulumi
import pulumi_databricks as databricks

this = databricks.AibiDashboardEmbeddingAccessPolicySetting("this", aibi_dashboard_embedding_access_policy={
    "access_policy_type": "ALLOW_APPROVED_DOMAINS",
})
this_aibi_dashboard_embedding_approved_domains_setting = databricks.AibiDashboardEmbeddingApprovedDomainsSetting("this", aibi_dashboard_embedding_approved_domains={
    "approved_domains": ["test.com"],
},
opts = pulumi.ResourceOptions(depends_on=[this]))
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 {
		this, err := databricks.NewAibiDashboardEmbeddingAccessPolicySetting(ctx, "this", &databricks.AibiDashboardEmbeddingAccessPolicySettingArgs{
			AibiDashboardEmbeddingAccessPolicy: &databricks.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs{
				AccessPolicyType: pulumi.String("ALLOW_APPROVED_DOMAINS"),
			},
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewAibiDashboardEmbeddingApprovedDomainsSetting(ctx, "this", &databricks.AibiDashboardEmbeddingApprovedDomainsSettingArgs{
			AibiDashboardEmbeddingApprovedDomains: &databricks.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs{
				ApprovedDomains: pulumi.StringArray{
					pulumi.String("test.com"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			this,
		}))
		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",
        },
    });

    var thisAibiDashboardEmbeddingApprovedDomainsSetting = new Databricks.AibiDashboardEmbeddingApprovedDomainsSetting("this", new()
    {
        AibiDashboardEmbeddingApprovedDomains = new Databricks.Inputs.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs
        {
            ApprovedDomains = new[]
            {
                "test.com",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            @this,
        },
    });

});
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 com.pulumi.databricks.AibiDashboardEmbeddingApprovedDomainsSetting;
import com.pulumi.databricks.AibiDashboardEmbeddingApprovedDomainsSettingArgs;
import com.pulumi.databricks.inputs.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs;
import com.pulumi.resources.CustomResourceOptions;
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());

        var thisAibiDashboardEmbeddingApprovedDomainsSetting = new AibiDashboardEmbeddingApprovedDomainsSetting("thisAibiDashboardEmbeddingApprovedDomainsSetting", AibiDashboardEmbeddingApprovedDomainsSettingArgs.builder()
            .aibiDashboardEmbeddingApprovedDomains(AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs.builder()
                .approvedDomains("test.com")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(this_)
                .build());

    }
}
Copy
resources:
  this:
    type: databricks:AibiDashboardEmbeddingAccessPolicySetting
    properties:
      aibiDashboardEmbeddingAccessPolicy:
        accessPolicyType: ALLOW_APPROVED_DOMAINS
  thisAibiDashboardEmbeddingApprovedDomainsSetting:
    type: databricks:AibiDashboardEmbeddingApprovedDomainsSetting
    name: this
    properties:
      aibiDashboardEmbeddingApprovedDomains:
        approvedDomains:
          - test.com
    options:
      dependsOn:
        - ${this}
Copy

The following resources are often used in the same context:

  • databricks.AibiDashboardEmbeddingAccessPolicySetting is used to control embedding policy.

Create AibiDashboardEmbeddingApprovedDomainsSetting Resource

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

Constructor syntax

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

@overload
def AibiDashboardEmbeddingApprovedDomainsSetting(resource_name: str,
                                                 opts: Optional[ResourceOptions] = None,
                                                 aibi_dashboard_embedding_approved_domains: Optional[AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs] = None,
                                                 etag: Optional[str] = None,
                                                 setting_name: Optional[str] = None)
func NewAibiDashboardEmbeddingApprovedDomainsSetting(ctx *Context, name string, args AibiDashboardEmbeddingApprovedDomainsSettingArgs, opts ...ResourceOption) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)
public AibiDashboardEmbeddingApprovedDomainsSetting(string name, AibiDashboardEmbeddingApprovedDomainsSettingArgs args, CustomResourceOptions? opts = null)
public AibiDashboardEmbeddingApprovedDomainsSetting(String name, AibiDashboardEmbeddingApprovedDomainsSettingArgs args)
public AibiDashboardEmbeddingApprovedDomainsSetting(String name, AibiDashboardEmbeddingApprovedDomainsSettingArgs args, CustomResourceOptions options)

type: databricks:AibiDashboardEmbeddingApprovedDomainsSetting
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. AibiDashboardEmbeddingApprovedDomainsSettingArgs
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. AibiDashboardEmbeddingApprovedDomainsSettingArgs
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. AibiDashboardEmbeddingApprovedDomainsSettingArgs
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. AibiDashboardEmbeddingApprovedDomainsSettingArgs
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. AibiDashboardEmbeddingApprovedDomainsSettingArgs
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 aibiDashboardEmbeddingApprovedDomainsSettingResource = new Databricks.AibiDashboardEmbeddingApprovedDomainsSetting("aibiDashboardEmbeddingApprovedDomainsSettingResource", new()
{
    AibiDashboardEmbeddingApprovedDomains = new Databricks.Inputs.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs
    {
        ApprovedDomains = new[]
        {
            "string",
        },
    },
    Etag = "string",
    SettingName = "string",
});
Copy
example, err := databricks.NewAibiDashboardEmbeddingApprovedDomainsSetting(ctx, "aibiDashboardEmbeddingApprovedDomainsSettingResource", &databricks.AibiDashboardEmbeddingApprovedDomainsSettingArgs{
	AibiDashboardEmbeddingApprovedDomains: &databricks.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs{
		ApprovedDomains: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Etag:        pulumi.String("string"),
	SettingName: pulumi.String("string"),
})
Copy
var aibiDashboardEmbeddingApprovedDomainsSettingResource = new AibiDashboardEmbeddingApprovedDomainsSetting("aibiDashboardEmbeddingApprovedDomainsSettingResource", AibiDashboardEmbeddingApprovedDomainsSettingArgs.builder()
    .aibiDashboardEmbeddingApprovedDomains(AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs.builder()
        .approvedDomains("string")
        .build())
    .etag("string")
    .settingName("string")
    .build());
Copy
aibi_dashboard_embedding_approved_domains_setting_resource = databricks.AibiDashboardEmbeddingApprovedDomainsSetting("aibiDashboardEmbeddingApprovedDomainsSettingResource",
    aibi_dashboard_embedding_approved_domains={
        "approved_domains": ["string"],
    },
    etag="string",
    setting_name="string")
Copy
const aibiDashboardEmbeddingApprovedDomainsSettingResource = new databricks.AibiDashboardEmbeddingApprovedDomainsSetting("aibiDashboardEmbeddingApprovedDomainsSettingResource", {
    aibiDashboardEmbeddingApprovedDomains: {
        approvedDomains: ["string"],
    },
    etag: "string",
    settingName: "string",
});
Copy
type: databricks:AibiDashboardEmbeddingApprovedDomainsSetting
properties:
    aibiDashboardEmbeddingApprovedDomains:
        approvedDomains:
            - string
    etag: string
    settingName: string
Copy

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

aibiDashboardEmbeddingApprovedDomains 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 AibiDashboardEmbeddingApprovedDomainsSetting 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 AibiDashboardEmbeddingApprovedDomainsSetting Resource

Get an existing AibiDashboardEmbeddingApprovedDomainsSetting 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?: AibiDashboardEmbeddingApprovedDomainsSettingState, opts?: CustomResourceOptions): AibiDashboardEmbeddingApprovedDomainsSetting
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aibi_dashboard_embedding_approved_domains: Optional[AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs] = None,
        etag: Optional[str] = None,
        setting_name: Optional[str] = None) -> AibiDashboardEmbeddingApprovedDomainsSetting
func GetAibiDashboardEmbeddingApprovedDomainsSetting(ctx *Context, name string, id IDInput, state *AibiDashboardEmbeddingApprovedDomainsSettingState, opts ...ResourceOption) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)
public static AibiDashboardEmbeddingApprovedDomainsSetting Get(string name, Input<string> id, AibiDashboardEmbeddingApprovedDomainsSettingState? state, CustomResourceOptions? opts = null)
public static AibiDashboardEmbeddingApprovedDomainsSetting get(String name, Output<String> id, AibiDashboardEmbeddingApprovedDomainsSettingState state, CustomResourceOptions options)
resources:  _:    type: databricks:AibiDashboardEmbeddingApprovedDomainsSetting    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:
aibiDashboardEmbeddingApprovedDomains Property Map
block with following attributes:
etag String
settingName String

Supporting Types

AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains
, AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs

ApprovedDomains This property is required. List<string>
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.
ApprovedDomains This property is required. []string
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.
approvedDomains This property is required. List<String>
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.
approvedDomains This property is required. string[]
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.
approved_domains This property is required. Sequence[str]
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.
approvedDomains This property is required. List<String>
the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name, i.e., *.databricks.com will allow to embed into any site under the databricks.com.

Import

This resource can be imported by predefined name global:

bash

$ pulumi import databricks:index/aibiDashboardEmbeddingApprovedDomainsSetting:AibiDashboardEmbeddingApprovedDomainsSetting 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.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks