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

Returns, takes, and removes Cloud Backup snapshots.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ClusterName string | Aws_CF_FunctionString required

Human-readable label that identifies the cluster.

ProjectId string | Aws_CF_FunctionString required

Unique 24-hexadecimal digit string that identifies your project.

Profile string | Aws_CF_FunctionString

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

InstanceName string | Aws_CF_FunctionString

Human-readable label that identifies the serverless instance.

Description string | Aws_CF_FunctionString

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

FrequencyType string | Aws_CF_FunctionString

Human-readable label that identifies how often this snapshot triggers.

IncludeCount boolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

ItemsPerPage integer

Number of items that the response returns per page.

Members object[]

List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when "type" : "SHARDED_CLUSTER".

PageNum integer

Number of the page that displays the current set of the total objects that the response returns.

PolicyItems string[]

List that contains unique identifiers for the policy items.

Results object[]

List of returned documents that MongoDB Cloud provides when completing this request.

RetentionInDays integer

Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1

SnapshotType string | Aws_CF_FunctionString

Human-readable label that identifies when this snapshot triggers.

TotalCount number

Number of documents returned in this response.

Definitions

ApiAtlasDiskBackupReplicaSetView object
CloudProvider string | Aws_CF_FunctionString

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

CreatedAt string | Aws_CF_FunctionString

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

Description string | Aws_CF_FunctionString

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

ExpiresAt string | Aws_CF_FunctionString

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

FrequencyType string | Aws_CF_FunctionString

Human-readable label that identifies how often this snapshot triggers.

Id string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the snapshot.

MasterKeyUUID string | Aws_CF_FunctionString

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

MongodVersion string | Aws_CF_FunctionString

Version of the MongoDB host that this snapshot backs up.

PolicyItems string[]

List that contains unique identifiers for the policy items.

ReplicaSetName string | Aws_CF_FunctionString

Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when "type": "replicaSet"

SnapshotType string | Aws_CF_FunctionString

Human-readable label that identifies when this snapshot triggers.

Status string | Aws_CF_FunctionString

Human-readable label that indicates the stage of the backup process for this snapshot.

StorageSizeBytes string | Aws_CF_FunctionString

Number of bytes taken to store the backup snapshot.

Type string | Aws_CF_FunctionString

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

ApiAtlasDiskBackupShardedClusterSnapshotMemberView object
CloudProvider string | Aws_CF_FunctionString

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

Id string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the snapshot.

ReplicaSetName string | Aws_CF_FunctionString

Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.

ApiAtlasDiskBackupShardedClusterSnapshotView object
CreatedAt string | Aws_CF_FunctionString

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

Description string | Aws_CF_FunctionString

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

ExpiresAt string | Aws_CF_FunctionString

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

FrequencyType string | Aws_CF_FunctionString

Human-readable label that identifies how often this snapshot triggers.

Id string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the snapshot.

MasterKeyUUID string | Aws_CF_FunctionString

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

Members object[]

List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when "type" : "SHARDED_CLUSTER".

MongodVersion string | Aws_CF_FunctionString

Version of the MongoDB host that this snapshot backs up.

PolicyItems string[]

List that contains unique identifiers for the policy items.

SnapshotIds string[]

List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when "type": "SHARDED_CLUSTER". These identifiers should match the ones specified in the members[n].id parameters. This allows you to map a snapshot to its shard or config host name.

SnapshotType string | Aws_CF_FunctionString

Human-readable label that identifies when this snapshot triggers.

Status string | Aws_CF_FunctionString

Human-readable label that indicates the stage of the backup process for this snapshot.

StorageSizeBytes string | Aws_CF_FunctionString

Number of bytes taken to store the backup snapshot.

Type string | Aws_CF_FunctionString

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

apiKeyDefinition object
PrivateKey string | Aws_CF_FunctionString
PublicKey string | Aws_CF_FunctionString