Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Dynatrace
  3. API Docs
  4. DashboardSharing
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
lbrlabs/pulumi-dynatrace

dynatrace.DashboardSharing

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
lbrlabs/pulumi-dynatrace

    This is a child resource of dynatrace_json_dashboard, therefore it is automatically retrieved with the dashboard.

    This resource requires the API token scopes Read configuration (ReadConfig) and Write configuration (WriteConfig)

    Dynatrace Documentation

    • Share Dynatrace dashboards - https://www.dynatrace.com/support/help/how-to-use-dynatrace/dashboards-and-charts/dashboards/share-dashboards

    • Dashboards API - https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/dashboards-api

    Create DashboardSharing Resource

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

    Constructor syntax

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

@overload
def DashboardSharing(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dashboard_id: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     permissions: Optional[DashboardSharingPermissionsArgs] = None,
                     preset: Optional[bool] = None,
                     public: Optional[DashboardSharingPublicArgs] = None)
    func NewDashboardSharing(ctx *Context, name string, args DashboardSharingArgs, opts ...ResourceOption) (*DashboardSharing, error)
    public DashboardSharing(string name, DashboardSharingArgs args, CustomResourceOptions? opts = null)
    public DashboardSharing(String name, DashboardSharingArgs args)
public DashboardSharing(String name, DashboardSharingArgs args, CustomResourceOptions options)

    type: dynatrace:DashboardSharing
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 DashboardSharingArgs
    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 DashboardSharingArgs
    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 DashboardSharingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardSharingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardSharingArgs
    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 dashboardSharingResource = new Dynatrace.DashboardSharing("dashboardSharingResource", new()
{
    DashboardId = "string",
    Enabled = false,
    Permissions = new Dynatrace.Inputs.DashboardSharingPermissionsArgs
    {
        Permissions = new[]
        {
            new Dynatrace.Inputs.DashboardSharingPermissionsPermissionArgs
            {
                Level = "string",
                Type = "string",
                Id = "string",
            },
        },
    },
    Preset = false,
    Public = new Dynatrace.Inputs.DashboardSharingPublicArgs
    {
        ManagementZones = new[]
        {
            "string",
        },
        Urls = 
        {
            { "string", "string" },
        },
    },
});

    example, err := dynatrace.NewDashboardSharing(ctx, "dashboardSharingResource", &dynatrace.DashboardSharingArgs{
	DashboardId: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Permissions: &dynatrace.DashboardSharingPermissionsArgs{
		Permissions: dynatrace.DashboardSharingPermissionsPermissionArray{
			&dynatrace.DashboardSharingPermissionsPermissionArgs{
				Level: pulumi.String("string"),
				Type:  pulumi.String("string"),
				Id:    pulumi.String("string"),
			},
		},
	},
	Preset: pulumi.Bool(false),
	Public: &dynatrace.DashboardSharingPublicArgs{
		ManagementZones: pulumi.StringArray{
			pulumi.String("string"),
		},
		Urls: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
})

    var dashboardSharingResource = new DashboardSharing("dashboardSharingResource", DashboardSharingArgs.builder()
    .dashboardId("string")
    .enabled(false)
    .permissions(DashboardSharingPermissionsArgs.builder()
        .permissions(DashboardSharingPermissionsPermissionArgs.builder()
            .level("string")
            .type("string")
            .id("string")
            .build())
        .build())
    .preset(false)
    .public_(DashboardSharingPublicArgs.builder()
        .managementZones("string")
        .urls(Map.of("string", "string"))
        .build())
    .build());

    dashboard_sharing_resource = dynatrace.DashboardSharing("dashboardSharingResource",
    dashboard_id="string",
    enabled=False,
    permissions={
        "permissions": [{
            "level": "string",
            "type": "string",
            "id": "string",
        }],
    },
    preset=False,
    public={
        "management_zones": ["string"],
        "urls": {
            "string": "string",
        },
    })

    const dashboardSharingResource = new dynatrace.DashboardSharing("dashboardSharingResource", {
    dashboardId: "string",
    enabled: false,
    permissions: {
        permissions: [{
            level: "string",
            type: "string",
            id: "string",
        }],
    },
    preset: false,
    "public": {
        managementZones: ["string"],
        urls: {
            string: "string",
        },
    },
});

    type: dynatrace:DashboardSharing
properties:
    dashboardId: string
    enabled: false
    permissions:
        permissions:
            - id: string
              level: string
              type: string
    preset: false
    public:
        managementZones:
            - string
        urls:
            string: string

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

    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Permissions Pulumiverse.Dynatrace.Inputs.DashboardSharingPermissions
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Public Pulumiverse.Dynatrace.Inputs.DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public_ DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboardId string
    The Dynatrace entity ID of the dashboard
    enabled boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboard_id str
    The Dynatrace entity ID of the dashboard
    enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    permissions Property Map
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public Property Map
    Configuration of the anonymous access to the dashboard

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Muted bool
    Reserved for internal use by the provider
    Id string
    The provider-assigned unique ID for this managed resource.
    Muted bool
    Reserved for internal use by the provider
    id String
    The provider-assigned unique ID for this managed resource.
    muted Boolean
    Reserved for internal use by the provider
    id string
    The provider-assigned unique ID for this managed resource.
    muted boolean
    Reserved for internal use by the provider
    id str
    The provider-assigned unique ID for this managed resource.
    muted bool
    Reserved for internal use by the provider
    id String
    The provider-assigned unique ID for this managed resource.
    muted Boolean
    Reserved for internal use by the provider

    Look up Existing DashboardSharing Resource

    Get an existing DashboardSharing 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?: DashboardSharingState, opts?: CustomResourceOptions): DashboardSharing
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        muted: Optional[bool] = None,
        permissions: Optional[DashboardSharingPermissionsArgs] = None,
        preset: Optional[bool] = None,
        public: Optional[DashboardSharingPublicArgs] = None) -> DashboardSharing
    func GetDashboardSharing(ctx *Context, name string, id IDInput, state *DashboardSharingState, opts ...ResourceOption) (*DashboardSharing, error)
    public static DashboardSharing Get(string name, Input<string> id, DashboardSharingState? state, CustomResourceOptions? opts = null)
    public static DashboardSharing get(String name, Output<String> id, DashboardSharingState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Muted bool
    Reserved for internal use by the provider
    Permissions Pulumiverse.Dynatrace.Inputs.DashboardSharingPermissions
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Public Pulumiverse.Dynatrace.Inputs.DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Muted bool
    Reserved for internal use by the provider
    Permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    Public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    muted Boolean
    Reserved for internal use by the provider
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public_ DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboardId string
    The Dynatrace entity ID of the dashboard
    enabled boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    muted boolean
    Reserved for internal use by the provider
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboard_id str
    The Dynatrace entity ID of the dashboard
    enabled bool
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    muted bool
    Reserved for internal use by the provider
    permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    preset bool
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false). Make sure that this value is aligned with the attribute shared of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    muted Boolean
    Reserved for internal use by the provider
    permissions Property Map
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset. Setting this attribute to true will automatically enforce a specific set of permissions - Dashboards flagged as Preset are shared by default. Make sure that this value is aligned with the attribute preset of the resources dynatrace.Dashboard and dynatrace.JsonDashboard. Otherwise you will encounter non-empty plans.
    public Property Map
    Configuration of the anonymous access to the dashboard

    Supporting Types

    DashboardSharingPermissions, DashboardSharingPermissionsArgs

    Permissions []DashboardSharingPermissionsPermission
    Access permissions of the dashboard
    permissions List<DashboardSharingPermissionsPermission>
    Access permissions of the dashboard
    permissions DashboardSharingPermissionsPermission[]
    Access permissions of the dashboard
    permissions List<Property Map>
    Access permissions of the dashboard

    DashboardSharingPermissionsPermission, DashboardSharingPermissionsPermissionArgs

    Level string
    The level of the permission:
    Type string
    The type of the permission:
    Id string
    The ID of the user or group to whom the permission is granted.
    Level string
    The level of the permission:
    Type string
    The type of the permission:
    Id string
    The ID of the user or group to whom the permission is granted.
    level String
    The level of the permission:
    type String
    The type of the permission:
    id String
    The ID of the user or group to whom the permission is granted.
    level string
    The level of the permission:
    type string
    The type of the permission:
    id string
    The ID of the user or group to whom the permission is granted.
    level str
    The level of the permission:
    type str
    The type of the permission:
    id str
    The ID of the user or group to whom the permission is granted.
    level String
    The level of the permission:
    type String
    The type of the permission:
    id String
    The ID of the user or group to whom the permission is granted.

    DashboardSharingPublic, DashboardSharingPublicArgs

    ManagementZones List<string>
    A list of management zones that can display data on the publicly shared dashboard.
    Urls Dictionary<string, string>
    A list of URLs for anonymous access to the dashboard indexed by management zone name
    ManagementZones []string
    A list of management zones that can display data on the publicly shared dashboard.
    Urls map[string]string
    A list of URLs for anonymous access to the dashboard indexed by management zone name
    managementZones List<String>
    A list of management zones that can display data on the publicly shared dashboard.
    urls Map<String,String>
    A list of URLs for anonymous access to the dashboard indexed by management zone name
    managementZones string[]
    A list of management zones that can display data on the publicly shared dashboard.
    urls {[key: string]: string}
    A list of URLs for anonymous access to the dashboard indexed by management zone name
    management_zones Sequence[str]
    A list of management zones that can display data on the publicly shared dashboard.
    urls Mapping[str, str]
    A list of URLs for anonymous access to the dashboard indexed by management zone name
    managementZones List<String>
    A list of management zones that can display data on the publicly shared dashboard.
    urls Map<String>
    A list of URLs for anonymous access to the dashboard indexed by management zone name

    Package Details

    Repository
    dynatrace pulumiverse/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
    lbrlabs/pulumi-dynatrace