Skip to content

README.md

Latest commit

 

History

History
71 lines (49 loc) · 2.81 KB

README.md

File metadata and controls

71 lines (49 loc) · 2.81 KB

online-archive

The official MongoDB Atlas AWS CDK resource for Node.js.

AWS CDK L1 construct and data structures for the AWS CloudFormation Registry type MongoDB::Atlas::OnlineArchive v1.0.0.

Description

Returns, adds, edits, or removes an online archive.

MongoDB Atlas API Docs

For more information about the API refer to: API Endpoints

Usage

In order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the AWS CLI using the following command:

aws cloudformation activate-type \
  --type-name MongoDB::Atlas::OnlineArchive \
  --publisher-id bb989456c78c398a858fef18f2ca1bfc1fbba082 \
  --type RESOURCE \
  --execution-role-arn ROLE-ARN

Alternatively:

aws cloudformation activate-type \
  --public-type-arn arn:aws:cloudformation:us-east-1::type/resource/bb989456c78c398a858fef18f2ca1bfc1fbba082/MongoDB-Atlas-OnlineArchive \
  --execution-role-arn ROLE-ARN

You can find more information about activating this type in the AWS CloudFormation documentation.

Example: online-archive.ts

import { CfnOnlineArchive, CriteriaViewType} from 'awscdk-resources-mongodbatlas';


const myOnlineArchive = new CfnOnlineArchive(this, 'MyOnlineArchive', {
    projectId: atlasProps.projId,
    profile: atlasProps.profile,
    collName: atlasProps.collName,
    dbName: atlasProps.dbName,
    criteria: {
    type: CriteriaViewType.DATE,
    dateFormat: 'ISODATE',
    dateField: "created",
    expireAfterDays: 30
    }
});

Feedback

This library is auto-generated and published to all supported programming languages by the cdklabs/cdk-cloudformation project based on the API schema published for MongoDB::Atlas::OnlineArchive.

  • Issues related to this generated library should be reported here.
  • Issues related to MongoDB::Atlas::OnlineArchive should be reported to the publisher.
  • Feature requests should be reported here

License

Distributed under the Apache-2.0 License.
⚡