Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-encryptionatrest.json
Parent schema serverless-framework-configuration
Type: object

Returns and edits the Encryption at Rest using Customer Key Management configuration.. Source:- No source definition found, add manually please

Properties

AwsKms object required

Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

4 nested properties
RoleID string | Aws_CF_FunctionString

ID of an AWS IAM role authorized to manage an AWS customer master key.

CustomerMasterKeyID string | Aws_CF_FunctionString

The AWS customer master key used to encrypt and decrypt the MongoDB master keys.

Enabled boolean

Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.

Region string | Aws_CF_FunctionString

The AWS region in which the AWS customer master key exists.

ProjectId string | Aws_CF_FunctionString required

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

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

Definitions

AwsKms object

Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

RoleID string | Aws_CF_FunctionString

ID of an AWS IAM role authorized to manage an AWS customer master key.

CustomerMasterKeyID string | Aws_CF_FunctionString

The AWS customer master key used to encrypt and decrypt the MongoDB master keys.

Enabled boolean

Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.

Region string | Aws_CF_FunctionString

The AWS region in which the AWS customer master key exists.