MongoDb::Atlas::AwsIamDatabaseUser

CRUD for AWS IAM MongoDB users in a project for your clusters/databases.

Syntax

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

JSON

{
    "Type" : "MongoDb::Atlas::AwsIamDatabaseUser",
    "Properties" : {
        "AwsIamResource" : String,
        "ApiKeys" : apiKeyDefinition,
        "ProjectId" : String,
        "DatabaseAccess" : DatabaseAccess,
        "Scopes" : Scopes,
    }
}

YAML

Type: MongoDb::Atlas::AwsIamDatabaseUser
Properties:
    AwsIamResource: String
    ApiKeys: apiKeyDefinition
    ProjectId: String
    DatabaseAccess: DatabaseAccess
    Scopes: Scopes

Properties

AwsIamResource

The AWS IAM user or role ARN used as the database username.

Required: Yes

Type: String

Pattern: ^arn:aws(?:-[a-z-]+)?:iam::[0-9]{12}:(role|user)/[\S]+$

Update requires: No interruption

ApiKeys

Required: Yes

Type: apiKeyDefinition

Update requires: No interruption

ProjectId

Unique identifier of the Atlas project to which the user belongs.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]+$

Update requires: Replacement

DatabaseAccess

Required: Yes

Type: DatabaseAccess

Update requires: No interruption

Scopes

Required: No

Type: Scopes

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the MongoDbUsername.

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.

MongoDbUsername

MongoDB username for the AWS IAM resource.