1. Packages
  2. Datadog Provider
  3. API Docs
  4. SecureEmbedDashboard
Viewing docs for Datadog v5.1.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.SecureEmbedDashboard

datadog logo
Viewing docs for Datadog v5.1.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Manages a Datadog secure embed shared dashboard. NOTE: The HMAC credential is only returned by the API once on creation and is stored in Terraform state. Ensure your state backend uses encryption at rest and has appropriate access controls.

    Create SecureEmbedDashboard Resource

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

    Constructor syntax

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

@overload
def SecureEmbedDashboard(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         dashboard_id: Optional[str] = None,
                         title: Optional[str] = None,
                         global_time_live_span: Optional[str] = None,
                         global_time_selectable: Optional[bool] = None,
                         selectable_template_vars: Optional[Sequence[SecureEmbedDashboardSelectableTemplateVarArgs]] = None,
                         status: Optional[str] = None,
                         viewing_preferences_high_density: Optional[bool] = None,
                         viewing_preferences_theme: Optional[str] = None)
    func NewSecureEmbedDashboard(ctx *Context, name string, args SecureEmbedDashboardArgs, opts ...ResourceOption) (*SecureEmbedDashboard, error)
    public SecureEmbedDashboard(string name, SecureEmbedDashboardArgs args, CustomResourceOptions? opts = null)
    public SecureEmbedDashboard(String name, SecureEmbedDashboardArgs args)
public SecureEmbedDashboard(String name, SecureEmbedDashboardArgs args, CustomResourceOptions options)

    type: datadog:SecureEmbedDashboard
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 SecureEmbedDashboardArgs
    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 SecureEmbedDashboardArgs
    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 SecureEmbedDashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecureEmbedDashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecureEmbedDashboardArgs
    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 secureEmbedDashboardResource = new Datadog.Index.SecureEmbedDashboard("secureEmbedDashboardResource", new()
{
    DashboardId = "string",
    Title = "string",
    GlobalTimeLiveSpan = "string",
    GlobalTimeSelectable = false,
    SelectableTemplateVars = new[]
    {
        new Datadog.Inputs.SecureEmbedDashboardSelectableTemplateVarArgs
        {
            Name = "string",
            DefaultValues = new[]
            {
                "string",
            },
            Prefix = "string",
            Type = "string",
            VisibleTags = new[]
            {
                "string",
            },
        },
    },
    Status = "string",
    ViewingPreferencesHighDensity = false,
    ViewingPreferencesTheme = "string",
});

    example, err := datadog.NewSecureEmbedDashboard(ctx, "secureEmbedDashboardResource", &datadog.SecureEmbedDashboardArgs{
	DashboardId:          pulumi.String("string"),
	Title:                pulumi.String("string"),
	GlobalTimeLiveSpan:   pulumi.String("string"),
	GlobalTimeSelectable: pulumi.Bool(false),
	SelectableTemplateVars: datadog.SecureEmbedDashboardSelectableTemplateVarArray{
		&datadog.SecureEmbedDashboardSelectableTemplateVarArgs{
			Name: pulumi.String("string"),
			DefaultValues: pulumi.StringArray{
				pulumi.String("string"),
			},
			Prefix: pulumi.String("string"),
			Type:   pulumi.String("string"),
			VisibleTags: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Status:                        pulumi.String("string"),
	ViewingPreferencesHighDensity: pulumi.Bool(false),
	ViewingPreferencesTheme:       pulumi.String("string"),
})

    var secureEmbedDashboardResource = new SecureEmbedDashboard("secureEmbedDashboardResource", SecureEmbedDashboardArgs.builder()
    .dashboardId("string")
    .title("string")
    .globalTimeLiveSpan("string")
    .globalTimeSelectable(false)
    .selectableTemplateVars(SecureEmbedDashboardSelectableTemplateVarArgs.builder()
        .name("string")
        .defaultValues("string")
        .prefix("string")
        .type("string")
        .visibleTags("string")
        .build())
    .status("string")
    .viewingPreferencesHighDensity(false)
    .viewingPreferencesTheme("string")
    .build());

    secure_embed_dashboard_resource = datadog.SecureEmbedDashboard("secureEmbedDashboardResource",
    dashboard_id="string",
    title="string",
    global_time_live_span="string",
    global_time_selectable=False,
    selectable_template_vars=[{
        "name": "string",
        "default_values": ["string"],
        "prefix": "string",
        "type": "string",
        "visible_tags": ["string"],
    }],
    status="string",
    viewing_preferences_high_density=False,
    viewing_preferences_theme="string")

    const secureEmbedDashboardResource = new datadog.SecureEmbedDashboard("secureEmbedDashboardResource", {
    dashboardId: "string",
    title: "string",
    globalTimeLiveSpan: "string",
    globalTimeSelectable: false,
    selectableTemplateVars: [{
        name: "string",
        defaultValues: ["string"],
        prefix: "string",
        type: "string",
        visibleTags: ["string"],
    }],
    status: "string",
    viewingPreferencesHighDensity: false,
    viewingPreferencesTheme: "string",
});

    type: datadog:SecureEmbedDashboard
properties:
    dashboardId: string
    globalTimeLiveSpan: string
    globalTimeSelectable: false
    selectableTemplateVars:
        - defaultValues:
            - string
          name: string
          prefix: string
          type: string
          visibleTags:
            - string
    status: string
    title: string
    viewingPreferencesHighDensity: false
    viewingPreferencesTheme: string

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

    DashboardId string
    The ID of the dashboard to create a secure embed for.
    Title string
    Title of the secure embed share.
    GlobalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    GlobalTimeSelectable bool
    Whether viewers can change the global time range. Defaults to true.
    SelectableTemplateVars List<SecureEmbedDashboardSelectableTemplateVar>
    Template variables that viewers can filter by.
    Status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    ViewingPreferencesHighDensity bool
    Whether to display the dashboard in high density mode. Defaults to false.
    ViewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    DashboardId string
    The ID of the dashboard to create a secure embed for.
    Title string
    Title of the secure embed share.
    GlobalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    GlobalTimeSelectable bool
    Whether viewers can change the global time range. Defaults to true.
    SelectableTemplateVars []SecureEmbedDashboardSelectableTemplateVarArgs
    Template variables that viewers can filter by.
    Status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    ViewingPreferencesHighDensity bool
    Whether to display the dashboard in high density mode. Defaults to false.
    ViewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    dashboardId String
    The ID of the dashboard to create a secure embed for.
    title String
    Title of the secure embed share.
    globalTimeLiveSpan String
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable Boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars List<SecureEmbedDashboardSelectableTemplateVar>
    Template variables that viewers can filter by.
    status String
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    viewingPreferencesHighDensity Boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme String
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    dashboardId string
    The ID of the dashboard to create a secure embed for.
    title string
    Title of the secure embed share.
    globalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars SecureEmbedDashboardSelectableTemplateVar[]
    Template variables that viewers can filter by.
    status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    viewingPreferencesHighDensity boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    dashboard_id str
    The ID of the dashboard to create a secure embed for.
    title str
    Title of the secure embed share.
    global_time_live_span str
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    global_time_selectable bool
    Whether viewers can change the global time range. Defaults to true.
    selectable_template_vars Sequence[SecureEmbedDashboardSelectableTemplateVarArgs]
    Template variables that viewers can filter by.
    status str
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    viewing_preferences_high_density bool
    Whether to display the dashboard in high density mode. Defaults to false.
    viewing_preferences_theme str
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    dashboardId String
    The ID of the dashboard to create a secure embed for.
    title String
    Title of the secure embed share.
    globalTimeLiveSpan String
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable Boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars List<Property Map>
    Template variables that viewers can filter by.
    status String
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    viewingPreferencesHighDensity Boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme String
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecureEmbedDashboard resource produces the following output properties:

    Credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The share token for the secure embed.
    Url string
    The public URL for the embedded dashboard.
    Credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The share token for the secure embed.
    Url string
    The public URL for the embedded dashboard.
    credential String
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The share token for the secure embed.
    url String
    The public URL for the embedded dashboard.
    credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The share token for the secure embed.
    url string
    The public URL for the embedded dashboard.
    credential str
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The share token for the secure embed.
    url str
    The public URL for the embedded dashboard.
    credential String
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The share token for the secure embed.
    url String
    The public URL for the embedded dashboard.

    Look up Existing SecureEmbedDashboard Resource

    Get an existing SecureEmbedDashboard 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?: SecureEmbedDashboardState, opts?: CustomResourceOptions): SecureEmbedDashboard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential: Optional[str] = None,
        dashboard_id: Optional[str] = None,
        global_time_live_span: Optional[str] = None,
        global_time_selectable: Optional[bool] = None,
        selectable_template_vars: Optional[Sequence[SecureEmbedDashboardSelectableTemplateVarArgs]] = None,
        status: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        url: Optional[str] = None,
        viewing_preferences_high_density: Optional[bool] = None,
        viewing_preferences_theme: Optional[str] = None) -> SecureEmbedDashboard
    func GetSecureEmbedDashboard(ctx *Context, name string, id IDInput, state *SecureEmbedDashboardState, opts ...ResourceOption) (*SecureEmbedDashboard, error)
    public static SecureEmbedDashboard Get(string name, Input<string> id, SecureEmbedDashboardState? state, CustomResourceOptions? opts = null)
    public static SecureEmbedDashboard get(String name, Output<String> id, SecureEmbedDashboardState state, CustomResourceOptions options)
    resources:  _:    type: datadog:SecureEmbedDashboard    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.
    The following state arguments are supported:
    Credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    DashboardId string
    The ID of the dashboard to create a secure embed for.
    GlobalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    GlobalTimeSelectable bool
    Whether viewers can change the global time range. Defaults to true.
    SelectableTemplateVars List<SecureEmbedDashboardSelectableTemplateVar>
    Template variables that viewers can filter by.
    Status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    Title string
    Title of the secure embed share.
    Token string
    The share token for the secure embed.
    Url string
    The public URL for the embedded dashboard.
    ViewingPreferencesHighDensity bool
    Whether to display the dashboard in high density mode. Defaults to false.
    ViewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    Credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    DashboardId string
    The ID of the dashboard to create a secure embed for.
    GlobalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    GlobalTimeSelectable bool
    Whether viewers can change the global time range. Defaults to true.
    SelectableTemplateVars []SecureEmbedDashboardSelectableTemplateVarArgs
    Template variables that viewers can filter by.
    Status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    Title string
    Title of the secure embed share.
    Token string
    The share token for the secure embed.
    Url string
    The public URL for the embedded dashboard.
    ViewingPreferencesHighDensity bool
    Whether to display the dashboard in high density mode. Defaults to false.
    ViewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    credential String
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    dashboardId String
    The ID of the dashboard to create a secure embed for.
    globalTimeLiveSpan String
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable Boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars List<SecureEmbedDashboardSelectableTemplateVar>
    Template variables that viewers can filter by.
    status String
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    title String
    Title of the secure embed share.
    token String
    The share token for the secure embed.
    url String
    The public URL for the embedded dashboard.
    viewingPreferencesHighDensity Boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme String
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    credential string
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    dashboardId string
    The ID of the dashboard to create a secure embed for.
    globalTimeLiveSpan string
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars SecureEmbedDashboardSelectableTemplateVar[]
    Template variables that viewers can filter by.
    status string
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    title string
    Title of the secure embed share.
    token string
    The share token for the secure embed.
    url string
    The public URL for the embedded dashboard.
    viewingPreferencesHighDensity boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme string
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    credential str
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    dashboard_id str
    The ID of the dashboard to create a secure embed for.
    global_time_live_span str
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    global_time_selectable bool
    Whether viewers can change the global time range. Defaults to true.
    selectable_template_vars Sequence[SecureEmbedDashboardSelectableTemplateVarArgs]
    Template variables that viewers can filter by.
    status str
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    title str
    Title of the secure embed share.
    token str
    The share token for the secure embed.
    url str
    The public URL for the embedded dashboard.
    viewing_preferences_high_density bool
    Whether to display the dashboard in high density mode. Defaults to false.
    viewing_preferences_theme str
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".
    credential String
    The HMAC credential granting access to this secure embed. Only available on initial creation; stored in state.
    dashboardId String
    The ID of the dashboard to create a secure embed for.
    globalTimeLiveSpan String
    The live span for the global time, e.g. 1h, 4h, 1d, 2d, 1w. Defaults to "1h".
    globalTimeSelectable Boolean
    Whether viewers can change the global time range. Defaults to true.
    selectableTemplateVars List<Property Map>
    Template variables that viewers can filter by.
    status String
    Status of the secure embed. Valid values are active and paused. Defaults to "active".
    title String
    Title of the secure embed share.
    token String
    The share token for the secure embed.
    url String
    The public URL for the embedded dashboard.
    viewingPreferencesHighDensity Boolean
    Whether to display the dashboard in high density mode. Defaults to false.
    viewingPreferencesTheme String
    Display theme for the embedded dashboard. Valid values are system, dark, light. Defaults to "system".

    Supporting Types

    SecureEmbedDashboardSelectableTemplateVar, SecureEmbedDashboardSelectableTemplateVarArgs

    Name string
    The name of the template variable.
    DefaultValues List<string>
    The default values for this template variable.
    Prefix string
    The tag prefix for this template variable. Defaults to "".
    Type string
    The type of the template variable. Defaults to "".
    VisibleTags List<string>
    The visible tag values for this template variable.
    Name string
    The name of the template variable.
    DefaultValues []string
    The default values for this template variable.
    Prefix string
    The tag prefix for this template variable. Defaults to "".
    Type string
    The type of the template variable. Defaults to "".
    VisibleTags []string
    The visible tag values for this template variable.
    name String
    The name of the template variable.
    defaultValues List<String>
    The default values for this template variable.
    prefix String
    The tag prefix for this template variable. Defaults to "".
    type String
    The type of the template variable. Defaults to "".
    visibleTags List<String>
    The visible tag values for this template variable.
    name string
    The name of the template variable.
    defaultValues string[]
    The default values for this template variable.
    prefix string
    The tag prefix for this template variable. Defaults to "".
    type string
    The type of the template variable. Defaults to "".
    visibleTags string[]
    The visible tag values for this template variable.
    name str
    The name of the template variable.
    default_values Sequence[str]
    The default values for this template variable.
    prefix str
    The tag prefix for this template variable. Defaults to "".
    type str
    The type of the template variable. Defaults to "".
    visible_tags Sequence[str]
    The visible tag values for this template variable.
    name String
    The name of the template variable.
    defaultValues List<String>
    The default values for this template variable.
    prefix String
    The tag prefix for this template variable. Defaults to "".
    type String
    The type of the template variable. Defaults to "".
    visibleTags List<String>
    The visible tag values for this template variable.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Viewing docs for Datadog v5.1.0
    published on Thursday, Apr 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog
      Try Pulumi Cloud free. Your team will thank you.