mongodb-atlas-databaseuser.json

{
  "additionalProperties": false,
  "definitions": {
    "labelDefinition": {
      "additionalProperties": false,
      "properties": {
        "Key": {
          "minLength": 1,
          "type": "string"
        },
        "Value": {
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    },
    "roleDefinition": {
      "additionalProperties": false,
      "properties": {
        "CollectionName": {
          "type": "string"
        },
        "DatabaseName": {
          "type": "string"
        },
        "RoleName": {
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    },
    "scopeDefinition": {
      "additionalProperties": false,
      "properties": {
        "Name": {
          "minLength": 1,
          "type": "string"
        },
        "Type": {
          "enum": [
            "CLUSTER",
            "DATA_LAKE"
          ],
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "handlers": {
    "create": {
      "permissions": [
        "secretsmanager:GetSecretValue"
      ]
    },
    "read": {
      "permissions": [
        "secretsmanager:GetSecretValue"
      ]
    },
    "update": {
      "permissions": [
        "secretsmanager:GetSecretValue"
      ]
    },
    "delete": {
      "permissions": [
        "secretsmanager:GetSecretValue"
      ]
    }
  },
  "properties": {
    "DeleteAfterDate": {
      "description": "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.",
      "type": "string"
    },
    "AWSIAMType": {
      "description": "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`.",
      "enum": [
        "NONE",
        "USER",
        "ROLE"
      ],
      "type": "string"
    },
    "DatabaseName": {
      "description": "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`.",
      "type": "string"
    },
    "Description": {
      "description": "Description of this database user.",
      "type": "string"
    },
    "Labels": {
      "description": "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.",
      "items": {
        "$ref": "#/definitions/labelDefinition"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    },
    "LdapAuthType": {
      "description": "Method by which the provided username is authenticated. Default value is `NONE`.",
      "enum": [
        "NONE",
        "USER",
        "GROUP"
      ],
      "type": "string"
    },
    "X509Type": {
      "description": "Method that briefs who owns the certificate provided. Default value is `NONE`.",
      "enum": [
        "NONE",
        "MANAGED",
        "CUSTOMER"
      ],
      "type": "string"
    },
    "Password": {
      "description": "The user’s password. This field is not included in the entity returned from the server.",
      "type": "string"
    },
    "ProjectId": {
      "description": "Unique 24-hexadecimal digit string that identifies your Atlas Project.",
      "type": "string"
    },
    "Roles": {
      "description": "List that provides the pairings of one role with one applicable database.",
      "items": {
        "$ref": "#/definitions/roleDefinition"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    },
    "Scopes": {
      "description": "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.",
      "items": {
        "$ref": "#/definitions/scopeDefinition"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    },
    "UserCFNIdentifier": {
      "description": "A unique identifier comprised of the Atlas Project ID and Username.",
      "type": "string"
    },
    "Username": {
      "description": "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.",
      "type": "string"
    },
    "Profile": {
      "type": "string",
      "description": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used",
      "default": "default"
    }
  },
  "readOnlyProperties": [
    "/properties/UserCFNIdentifier"
  ],
  "createOnlyProperties": [
    "/properties/ProjectId",
    "/properties/Profile"
  ],
  "required": [
    "DatabaseName",
    "ProjectId",
    "Roles",
    "Username"
  ],
  "primaryIdentifier": [
    "/properties/ProjectId",
    "/properties/DatabaseName",
    "/properties/Username",
    "/properties/Profile"
  ],
  "description": "Returns, adds, edits, and removes database users.",
  "typeName": "MongoDB::Atlas::DatabaseUser",
  "documentationUrl": "https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/database-user/README.md",
  "tagging": {
    "taggable": false
  },
  "sourceUrl": "https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master/cfn-resources/database-user"
}