com.pulumi.signalfx.DashboardGroup Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.signalfx;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.signalfx.DashboardGroupArgs;
import com.pulumi.signalfx.Utilities;
import com.pulumi.signalfx.inputs.DashboardGroupState;
import com.pulumi.signalfx.outputs.DashboardGroupDashboard;
import com.pulumi.signalfx.outputs.DashboardGroupImportQualifier;
import com.pulumi.signalfx.outputs.DashboardGroupPermission;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* In the Splunk Observability Cloud web UI, a [dashboard group](https://developers.signalfx.com/dashboard_groups_reference.html) is a collection of dashboards.
*
* Dashboard groups cannot be accessed directly. You can access them through a dashboard within a group.
*
* > **NOTE** When you want to change or remove write permissions for a user other than yourself regarding dashboard groups, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
*
* ## Example
*
* ## Example with permissions
*
* ## Example With mirrored dashboards
*
*/
@ResourceType(type="signalfx:index/dashboardGroup:DashboardGroup")
public class DashboardGroup extends com.pulumi.resources.CustomResource {
/**
* Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in `authorized_writer_teams`). **Note:** Deprecated use `permissions` instead.
*
* @deprecated
* Please use permissions field now
*
*/
@Deprecated /* Please use permissions field now */
@Export(name="authorizedWriterTeams", refs={List.class,String.class}, tree="[0,1]")
private Output> authorizedWriterTeams;
/**
* @return Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in `authorized_writer_teams`). **Note:** Deprecated use `permissions` instead.
*
*/
public Output>> authorizedWriterTeams() {
return Codegen.optional(this.authorizedWriterTeams);
}
/**
* User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorized_writer_teams`). **Note:** Deprecated use `permissions` instead.
*
* @deprecated
* Please use permissions field now
*
*/
@Deprecated /* Please use permissions field now */
@Export(name="authorizedWriterUsers", refs={List.class,String.class}, tree="[0,1]")
private Output> authorizedWriterUsers;
/**
* @return User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorized_writer_teams`). **Note:** Deprecated use `permissions` instead.
*
*/
public Output>> authorizedWriterUsers() {
return Codegen.optional(this.authorizedWriterUsers);
}
/**
* [Mirrored dashboards](https://docs.splunk.com/observability/en/data-visualization/dashboards/dashboard-share-clone-mirror.html#mirror-dashboard) in this dashboard group. **Note:** This feature is not present in all accounts. Please contact support if you are unsure.
*
*/
@Export(name="dashboards", refs={List.class,DashboardGroupDashboard.class}, tree="[0,1]")
private Output> dashboards;
/**
* @return [Mirrored dashboards](https://docs.splunk.com/observability/en/data-visualization/dashboards/dashboard-share-clone-mirror.html#mirror-dashboard) in this dashboard group. **Note:** This feature is not present in all accounts. Please contact support if you are unsure.
*
*/
public Output>> dashboards() {
return Codegen.optional(this.dashboards);
}
/**
* Description of the dashboard group.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Description of the dashboard group.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
@Export(name="importQualifiers", refs={List.class,DashboardGroupImportQualifier.class}, tree="[0,1]")
private Output> importQualifiers;
public Output>> importQualifiers() {
return Codegen.optional(this.importQualifiers);
}
/**
* Name of the dashboard group.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the dashboard group.
*
*/
public Output name() {
return this.name;
}
/**
* [Permissions](https://docs.splunk.com/Observability/infrastructure/terms-concepts/permissions.html) List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. **Note:** This feature is not present in all accounts. Please contact support if you are unsure.
*
*/
@Export(name="permissions", refs={List.class,DashboardGroupPermission.class}, tree="[0,1]")
private Output> permissions;
/**
* @return [Permissions](https://docs.splunk.com/Observability/infrastructure/terms-concepts/permissions.html) List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. **Note:** This feature is not present in all accounts. Please contact support if you are unsure.
*
*/
public Output> permissions() {
return this.permissions;
}
/**
* Team IDs to associate the dashboard group to.
*
*/
@Export(name="teams", refs={List.class,String.class}, tree="[0,1]")
private Output> teams;
/**
* @return Team IDs to associate the dashboard group to.
*
*/
public Output>> teams() {
return Codegen.optional(this.teams);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DashboardGroup(String name) {
this(name, DashboardGroupArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DashboardGroup(String name, @Nullable DashboardGroupArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public DashboardGroup(String name, @Nullable DashboardGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("signalfx:index/dashboardGroup:DashboardGroup", name, args == null ? DashboardGroupArgs.Empty : args, makeResourceOptions(options, Codegen.empty()));
}
private DashboardGroup(String name, Output id, @Nullable DashboardGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("signalfx:index/dashboardGroup:DashboardGroup", name, state, makeResourceOptions(options, id));
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static DashboardGroup get(String name, Output id, @Nullable DashboardGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DashboardGroup(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy