GetCustomDbRole

mongodbatlas..CustomDbRole describe a Custom DB Role. This represents a custom db role.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testRole = new Mongodbatlas.CustomDbRole("testRole", new Mongodbatlas.CustomDbRoleArgs
        {
            Actions = 
            {
                new Mongodbatlas.Inputs.CustomDbRoleActionArgs
                {
                    Action = "UPDATE",
                    Resources = 
                    {
                        new Mongodbatlas.Inputs.CustomDbRoleActionResourceArgs
                        {
                            CollectionName = "",
                            DatabaseName = "anyDatabase",
                        },
                    },
                },
                new Mongodbatlas.Inputs.CustomDbRoleActionArgs
                {
                    Action = "INSERT",
                    Resources = 
                    {
                        new Mongodbatlas.Inputs.CustomDbRoleActionResourceArgs
                        {
                            CollectionName = "",
                            DatabaseName = "anyDatabase",
                        },
                    },
                },
            },
            ProjectId = "<PROJECT-ID>",
            RoleName = "myCustomRole",
        });
        var test = Output.Tuple(testRole.ProjectId, testRole.RoleName).Apply(values =>
        {
            var projectId = values.Item1;
            var roleName = values.Item2;
            return Mongodbatlas.GetCustomDbRole.InvokeAsync(new Mongodbatlas.GetCustomDbRoleArgs
            {
                ProjectId = projectId,
                RoleName = roleName,
            });
        });
    }

}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_role = mongodbatlas.CustomDbRole("testRole",
    actions=[
        {
            "action": "UPDATE",
            "resources": [{
                "collectionName": "",
                "database_name": "anyDatabase",
            }],
        },
        {
            "action": "INSERT",
            "resources": [{
                "collectionName": "",
                "database_name": "anyDatabase",
            }],
        },
    ],
    project_id="<PROJECT-ID>",
    role_name="myCustomRole")
test = pulumi.Output.all(test_role.project_id, test_role.role_name).apply(lambda project_id, role_name: mongodbatlas.get_custom_db_role(project_id=project_id,
    role_name=role_name))

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testRole = new mongodbatlas.CustomDbRole("test_role", {
    actions: [
        {
            action: "UPDATE",
            resources: [{
                collectionName: "",
                databaseName: "anyDatabase",
            }],
        },
        {
            action: "INSERT",
            resources: [{
                collectionName: "",
                databaseName: "anyDatabase",
            }],
        },
    ],
    projectId: "<PROJECT-ID>",
    roleName: "myCustomRole",
});
const test = pulumi.all([testRole.projectId, testRole.roleName]).apply(([projectId, roleName]) => mongodbatlas.getCustomDbRole({
    projectId: projectId,
    roleName: roleName,
}, { async: true }));

Using GetCustomDbRole

function getCustomDbRole(args: GetCustomDbRoleArgs, opts?: InvokeOptions): Promise<GetCustomDbRoleResult>

function  get_custom_db_role(inherited_roles=None, project_id=None, role_name=None, opts=None)

func LookupCustomDbRole(ctx *Context, args *LookupCustomDbRoleArgs, opts ...InvokeOption) (*LookupCustomDbRoleResult, error)

Note: This function is named LookupCustomDbRole in the Go SDK.

public static class GetCustomDbRole {
    public static Task<GetCustomDbRoleResult> InvokeAsync(GetCustomDbRoleArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string: The unique ID for the project to create the database user.
RoleName string: Name of the custom role.
InheritedRoles List<GetCustomDbRoleInheritedRoleArgs>

ProjectId string: The unique ID for the project to create the database user.
RoleName string: Name of the custom role.
InheritedRoles []GetCustomDbRoleInheritedRole

projectId string: The unique ID for the project to create the database user.
roleName string: Name of the custom role.
inheritedRoles GetCustomDbRoleInheritedRole[]

project_id str: The unique ID for the project to create the database user.
role_name str: Name of the custom role.
inherited_roles List[GetCustomDbRoleInheritedRole]

GetCustomDbRole Result

The following output properties are available:

Actions List<GetCustomDbRoleAction>
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
RoleName string
InheritedRoles List<GetCustomDbRoleInheritedRole>

Actions []GetCustomDbRoleAction
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
RoleName string
InheritedRoles []GetCustomDbRoleInheritedRole

actions GetCustomDbRoleAction[]
id string: The provider-assigned unique ID for this managed resource.
projectId string
roleName string
inheritedRoles GetCustomDbRoleInheritedRole[]

actions List[GetCustomDbRoleAction]
id str: The provider-assigned unique ID for this managed resource.
project_id str
role_name str
inherited_roles List[GetCustomDbRoleInheritedRole]

Supporting Types

GetCustomDbRoleAction

See the output API doc for this type.

Action string: (Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.
Resources List<GetCustomDbRoleActionResourceArgs>: (Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

Action string: (Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.
Resources []GetCustomDbRoleActionResource: (Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

action string: (Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.
resources GetCustomDbRoleActionResource[]: (Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

action str: (Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.
resources List[GetCustomDbRoleActionResource]: (Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.