Skip to content

README.md

Latest commit

 

History

History
204 lines (121 loc) · 8.18 KB

README.md

File metadata and controls

204 lines (121 loc) · 8.18 KB

MongoDB::Atlas::DatabaseUser

Returns, adds, edits, and removes database users.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "MongoDB::Atlas::DatabaseUser",
    "Properties" : {
        "DeleteAfterDate" : String,
        "AWSIAMType" : String,
        "DatabaseName" : String,
        "Description" : String,
        "Labels" : [ labelDefinition, ... ],
        "LdapAuthType" : String,
        "X509Type" : String,
        "Password" : String,
        "ProjectId" : String,
        "Roles" : [ roleDefinition, ... ],
        "Scopes" : [ scopeDefinition, ... ],
        "Username" : String,
        "Profile" : String
    }
}

YAML

Type: MongoDB::Atlas::DatabaseUser
Properties:
    DeleteAfterDate: String
    AWSIAMType: String
    DatabaseName: String
    Description: String
    Labels: 
      - labelDefinition
    LdapAuthType: String
    X509Type: String
    Password: String
    ProjectId: String
    Roles: 
      - roleDefinition
    Scopes: 
      - scopeDefinition
    Username: String
    Profile: String

Properties

DeleteAfterDate

Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request.

Required: No

Type: String

Update requires: No interruption

AWSIAMType

Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. Default value is NONE.

Required: No

Type: String

Allowed Values: NONE | USER | ROLE

Update requires: No interruption

DatabaseName

MongoDB database against which the MongoDB database user authenticates. MongoDB database users must provide both a username and authentication database to log into MongoDB. Default value is admin.

Required: Yes

Type: String

Update requires: No interruption

Description

Description of this database user.

Required: No

Type: String

Update requires: No interruption

Labels

List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.

Required: No

Type: List of labelDefinition

Update requires: No interruption

LdapAuthType

Method by which the provided username is authenticated. Default value is NONE.

Required: No

Type: String

Allowed Values: NONE | USER | GROUP

Update requires: No interruption

X509Type

Method that briefs who owns the certificate provided. Default value is NONE.

Required: No

Type: String

Allowed Values: NONE | MANAGED | CUSTOMER

Update requires: No interruption

Password

The user’s password. This field is not included in the entity returned from the server.

Required: No

Type: String

Update requires: No interruption

ProjectId

Unique 24-hexadecimal digit string that identifies your Atlas Project.

Required: Yes

Type: String

Update requires: Replacement

Roles

List that provides the pairings of one role with one applicable database.

Required: Yes

Type: List of roleDefinition

Update requires: No interruption

Scopes

List that contains clusters and MongoDB Atlas Data Federation that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Federation in the project.

Required: No

Type: List of scopeDefinition

Update requires: No interruption

Username

Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication. This will be USER_ARN or ROLE_ARN if AWSIAMType is USER or ROLE. Refer https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Database-Users/operation/createDatabaseUser for details.

Required: Yes

Type: String

Update requires: No interruption

Profile

Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used

Required: No

Type: String

Update requires: Replacement

Return Values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

UserCFNIdentifier

A unique identifier comprised of the Atlas Project ID and Username.