Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. FolderPermission
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.FolderPermission

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Create FolderPermission Resource

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

    Constructor syntax

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

@overload
def FolderPermission(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     folder_uid: Optional[str] = None,
                     org_id: Optional[str] = None,
                     permissions: Optional[Sequence[FolderPermissionPermissionArgs]] = None)
    func NewFolderPermission(ctx *Context, name string, args FolderPermissionArgs, opts ...ResourceOption) (*FolderPermission, error)
    public FolderPermission(string name, FolderPermissionArgs args, CustomResourceOptions? opts = null)
    public FolderPermission(String name, FolderPermissionArgs args)
public FolderPermission(String name, FolderPermissionArgs args, CustomResourceOptions options)

    type: grafana:FolderPermission
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 FolderPermissionArgs
    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 FolderPermissionArgs
    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 FolderPermissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderPermissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderPermissionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var folderPermissionResource = new Grafana.FolderPermission("folderPermissionResource", new()
{
    FolderUid = "string",
    OrgId = "string",
    Permissions = new[]
    {
        new Grafana.Inputs.FolderPermissionPermissionArgs
        {
            Permission = "string",
            Role = "string",
            TeamId = "string",
            UserId = "string",
        },
    },
});

    example, err := grafana.NewFolderPermission(ctx, "folderPermissionResource", &grafana.FolderPermissionArgs{
	FolderUid: pulumi.String("string"),
	OrgId:     pulumi.String("string"),
	Permissions: grafana.FolderPermissionPermissionArray{
		&grafana.FolderPermissionPermissionArgs{
			Permission: pulumi.String("string"),
			Role:       pulumi.String("string"),
			TeamId:     pulumi.String("string"),
			UserId:     pulumi.String("string"),
		},
	},
})

    var folderPermissionResource = new FolderPermission("folderPermissionResource", FolderPermissionArgs.builder()        
    .folderUid("string")
    .orgId("string")
    .permissions(FolderPermissionPermissionArgs.builder()
        .permission("string")
        .role("string")
        .teamId("string")
        .userId("string")
        .build())
    .build());

    folder_permission_resource = grafana.FolderPermission("folderPermissionResource",
    folder_uid="string",
    org_id="string",
    permissions=[grafana.FolderPermissionPermissionArgs(
        permission="string",
        role="string",
        team_id="string",
        user_id="string",
    )])

    const folderPermissionResource = new grafana.FolderPermission("folderPermissionResource", {
    folderUid: "string",
    orgId: "string",
    permissions: [{
        permission: "string",
        role: "string",
        teamId: "string",
        userId: "string",
    }],
});

    type: grafana:FolderPermission
properties:
    folderUid: string
    orgId: string
    permissions:
        - permission: string
          role: string
          teamId: string
          userId: string

    FolderPermission Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FolderPermission resource accepts the following input properties:

    FolderUid string
    The UID of the folder.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Permissions List<Pulumiverse.Grafana.Inputs.FolderPermissionPermission>
    The permission items to add/update. Items that are omitted from the list will be removed.
    FolderUid string
    The UID of the folder.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Permissions []FolderPermissionPermissionArgs
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid String
    The UID of the folder.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions List<FolderPermissionPermission>
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid string
    The UID of the folder.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions FolderPermissionPermission[]
    The permission items to add/update. Items that are omitted from the list will be removed.
    folder_uid str
    The UID of the folder.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions Sequence[FolderPermissionPermissionArgs]
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid String
    The UID of the folder.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions List<Property Map>
    The permission items to add/update. Items that are omitted from the list will be removed.

    Outputs

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

    Get an existing FolderPermission 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?: FolderPermissionState, opts?: CustomResourceOptions): FolderPermission
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        folder_uid: Optional[str] = None,
        org_id: Optional[str] = None,
        permissions: Optional[Sequence[FolderPermissionPermissionArgs]] = None) -> FolderPermission
    func GetFolderPermission(ctx *Context, name string, id IDInput, state *FolderPermissionState, opts ...ResourceOption) (*FolderPermission, error)
    public static FolderPermission Get(string name, Input<string> id, FolderPermissionState? state, CustomResourceOptions? opts = null)
    public static FolderPermission get(String name, Output<String> id, FolderPermissionState 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:
    FolderUid string
    The UID of the folder.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Permissions List<Pulumiverse.Grafana.Inputs.FolderPermissionPermission>
    The permission items to add/update. Items that are omitted from the list will be removed.
    FolderUid string
    The UID of the folder.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Permissions []FolderPermissionPermissionArgs
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid String
    The UID of the folder.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions List<FolderPermissionPermission>
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid string
    The UID of the folder.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions FolderPermissionPermission[]
    The permission items to add/update. Items that are omitted from the list will be removed.
    folder_uid str
    The UID of the folder.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions Sequence[FolderPermissionPermissionArgs]
    The permission items to add/update. Items that are omitted from the list will be removed.
    folderUid String
    The UID of the folder.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    permissions List<Property Map>
    The permission items to add/update. Items that are omitted from the list will be removed.

    Supporting Types

    FolderPermissionPermission, FolderPermissionPermissionArgs

    Permission string
    Permission to associate with item. Must be one of View, Edit, or Admin.
    Role string
    Manage permissions for Viewer or Editor roles.
    TeamId string
    ID of the team to manage permissions for.
    UserId string
    ID of the user or service account to manage permissions for.
    Permission string
    Permission to associate with item. Must be one of View, Edit, or Admin.
    Role string
    Manage permissions for Viewer or Editor roles.
    TeamId string
    ID of the team to manage permissions for.
    UserId string
    ID of the user or service account to manage permissions for.
    permission String
    Permission to associate with item. Must be one of View, Edit, or Admin.
    role String
    Manage permissions for Viewer or Editor roles.
    teamId String
    ID of the team to manage permissions for.
    userId String
    ID of the user or service account to manage permissions for.
    permission string
    Permission to associate with item. Must be one of View, Edit, or Admin.
    role string
    Manage permissions for Viewer or Editor roles.
    teamId string
    ID of the team to manage permissions for.
    userId string
    ID of the user or service account to manage permissions for.
    permission str
    Permission to associate with item. Must be one of View, Edit, or Admin.
    role str
    Manage permissions for Viewer or Editor roles.
    team_id str
    ID of the team to manage permissions for.
    user_id str
    ID of the user or service account to manage permissions for.
    permission String
    Permission to associate with item. Must be one of View, Edit, or Admin.
    role String
    Manage permissions for Viewer or Editor roles.
    teamId String
    ID of the team to manage permissions for.
    userId String
    ID of the user or service account to manage permissions for.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-grafana