MongoDB Atlas v3.34.0 published on Friday, Jun 27, 2025 by Pulumi
mongodbatlas.getCustomDbRoles
Explore with Pulumi AI
# Data Source: mongodbatlas.getCustomDbRoles
mongodbatlas.getCustomDbRoles
describes all Custom DB Roles. This represents a custom db roles.
NOTE: Groups and projects are synonymous terms. You may find
groupId
in the official documentation.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
testDatabaseUser:
type: mongodbatlas:DatabaseUser
name: test
properties:
username: test-acc-username
password: test-acc-password
projectId: <PROJECT-ID>
databaseName: admin
roles:
- roleName: readWrite
databaseName: admin
- roleName: atlasAdmin
databaseName: admin
variables:
test:
fn::invoke:
function: mongodbatlas:getCustomDbRoles
arguments:
projectId: ${testMongodbatlasCustomDbRole.projectId}
Using getCustomDbRoles
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCustomDbRoles(args: GetCustomDbRolesArgs, opts?: InvokeOptions): Promise<GetCustomDbRolesResult>
function getCustomDbRolesOutput(args: GetCustomDbRolesOutputArgs, opts?: InvokeOptions): Output<GetCustomDbRolesResult>
def get_custom_db_roles(project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCustomDbRolesResult
def get_custom_db_roles_output(project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCustomDbRolesResult]
func LookupCustomDbRoles(ctx *Context, args *LookupCustomDbRolesArgs, opts ...InvokeOption) (*LookupCustomDbRolesResult, error)
func LookupCustomDbRolesOutput(ctx *Context, args *LookupCustomDbRolesOutputArgs, opts ...InvokeOption) LookupCustomDbRolesResultOutput
> Note: This function is named LookupCustomDbRoles
in the Go SDK.
public static class GetCustomDbRoles
{
public static Task<GetCustomDbRolesResult> InvokeAsync(GetCustomDbRolesArgs args, InvokeOptions? opts = null)
public static Output<GetCustomDbRolesResult> Invoke(GetCustomDbRolesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomDbRolesResult> getCustomDbRoles(GetCustomDbRolesArgs args, InvokeOptions options)
public static Output<GetCustomDbRolesResult> getCustomDbRoles(GetCustomDbRolesArgs args, InvokeOptions options)
fn::invoke:
function: mongodbatlas:index/getCustomDbRoles:getCustomDbRoles
arguments:
# arguments dictionary
The following arguments are supported:
- Project
Id string - The unique ID for the project to get all custom db roles.
- Project
Id string - The unique ID for the project to get all custom db roles.
- project
Id String - The unique ID for the project to get all custom db roles.
- project
Id string - The unique ID for the project to get all custom db roles.
- project_
id str - The unique ID for the project to get all custom db roles.
- project
Id String - The unique ID for the project to get all custom db roles.
getCustomDbRoles Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Results
List<Get
Custom Db Roles Result> - A list where each represents a custom db roles.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Results
[]Get
Custom Db Roles Result - A list where each represents a custom db roles.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - results
List<Get
Custom Db Roles Result> - A list where each represents a custom db roles.
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - results
Get
Custom Db Roles Result[] - A list where each represents a custom db roles.
- id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - results
Sequence[Get
Custom Db Roles Result] - A list where each represents a custom db roles.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - results List<Property Map>
- A list where each represents a custom db roles.
Supporting Types
GetCustomDbRolesResult
- Actions
List<Get
Custom Db Roles Result Action> - Inherited
Roles List<GetCustom Db Roles Result Inherited Role> - Role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- Actions
[]Get
Custom Db Roles Result Action - Inherited
Roles []GetCustom Db Roles Result Inherited Role - Role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- actions
List<Get
Custom Db Roles Result Action> - inherited
Roles List<GetCustom Db Roles Result Inherited Role> - role
Name String - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- actions
Get
Custom Db Roles Result Action[] - inherited
Roles GetCustom Db Roles Result Inherited Role[] - role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- actions
Sequence[Get
Custom Db Roles Result Action] - inherited_
roles Sequence[GetCustom Db Roles Result Inherited Role] - role_
name str - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- actions List<Property Map>
- inherited
Roles List<Property Map> - role
Name String - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
GetCustomDbRolesResultAction
- 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<Get
Custom Db Roles Result Action Resource> - (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
[]Get
Custom Db Roles Result Action Resource - (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
List<Get
Custom Db Roles Result Action Resource> - (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
Get
Custom Db Roles Result Action Resource[] - (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
Sequence[Get
Custom Db Roles Result Action Resource] - (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 List<Property Map>
- (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.
GetCustomDbRolesResultActionResource
- Cluster bool
- Collection
Name string - Database
Name string - (Required) Database on which the inherited role is granted.
- Cluster bool
- Collection
Name string - Database
Name string - (Required) Database on which the inherited role is granted.
- cluster Boolean
- collection
Name String - database
Name String - (Required) Database on which the inherited role is granted.
- cluster boolean
- collection
Name string - database
Name string - (Required) Database on which the inherited role is granted.
- cluster bool
- collection_
name str - database_
name str - (Required) Database on which the inherited role is granted.
- cluster Boolean
- collection
Name String - database
Name String - (Required) Database on which the inherited role is granted.
GetCustomDbRolesResultInheritedRole
- Database
Name string - (Required) Database on which the inherited role is granted.
- Role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- Database
Name string - (Required) Database on which the inherited role is granted.
- Role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- database
Name String - (Required) Database on which the inherited role is granted.
- role
Name String - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- database
Name string - (Required) Database on which the inherited role is granted.
- role
Name string - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- database_
name str - (Required) Database on which the inherited role is granted.
- role_
name str - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
- database
Name String - (Required) Database on which the inherited role is granted.
- role
Name String - (Required) Name of the inherited role. This can either be another custom role or a built-in role.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.