# MongoDB Atlas AWS CDK Resources [![Code Health](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/code-health.yml/badge.svg?event=push)](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/code-health.yml) [![Package CDK](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/package.yml/badge.svg?branch=main)](https://github.com/mongodb/awscdk-resources-mongodbatlas/actions/workflows/package.yml) [![npm version](https://badge.fury.io/js/awscdk-resources-mongodbatlas.svg)](https://badge.fury.io/js/awscdk-resources-mongodbatlas) [![PyPI version](https://badge.fury.io/py/awscdk-resources-mongodbatlas.svg)](https://badge.fury.io/py/awscdk-resources-mongodbatlas) [![NuGet version](https://badge.fury.io/nu/MongoDB.AWSCDKResourcesMongoDBAtlas.svg)](https://badge.fury.io/nu/MongoDB.AWSCDKResourcesMongoDBAtlas) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.mongodb/awscdk-resources-mongodbatlas/badge.svg)](https://central.sonatype.com/artifact/org.mongodb/awscdk-resources-mongodbatlas) [![Go Reference](https://pkg.go.dev/badge/github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas.svg)](https://pkg.go.dev/github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas) [![View on Construct Hub](https://constructs.dev/badge?package=aws-cdk-lib)](https://constructs.dev/packages/awscdk-resources-mongodbatlas) Use MongoDB Atlas [AWS CDK](https://aws.amazon.com/cdk/) (or Cloud Development Kit) constructs to manage [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). The AWS CDK is a framework for defining infrastructure as code (IaC). It allows developers to write code in their preferred programming language, such as TypeScript for example, to define and deploy infrastructure. AWS CDK gets synthesized down into [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates at deployment so users no longer have to write or maintain YAML/JSON based CloudFormation templates. ## Available Packages ### NPM The npm package is available at [awscdk-resources-mongodbatlas](https://www.npmjs.com/package/awscdk-resources-mongodbatlas) ```bash npm i awscdk-resources-mongodbatlas ``` ### PyPI The PyPI package is available at [awscdk-resources-mongodbatlas](https://pypi.org/project/awscdk-resources-mongodbatlas/) ```bash pip install awscdk-resources-mongodbatlas ``` ### Nuget The Nuget package is available at [MongoDB.AWSCDKResourcesMongoDBAtlas](https://www.nuget.org/packages/MongoDB.AWSCDKResourcesMongoDBAtlas) ```bash dotnet add package MongoDB.AWSCDKResourcesMongoDBAtlas --version 1.0.0 ``` ### Maven The Maven package is available at [awscdk-resources-mongodbatlas](https://central.sonatype.com/artifact/org.mongodb/awscdk-resources-mongodbatlas/1.0.0) ```Maven org.mongodb awscdk-resources-mongodbatlas 1.0.0 ``` ### Go The go package is generated into the [github.com/mongodb/awscdk-resources-mongodbatlas-go](https://github.com/mongodb/awscdk-resources-mongodbatlas-go) package. ```bash go get github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas ``` ## Available Constructors MongoDB Atlas AWS CDK Resources provides L1, L2 and L3 CDK constructors. Please, have a look at [README.md](src/README.md#cdk-constructors) for a full lists of constructors and examples. ## Getting Started See the [cdk examples](examples/README.md) for how to setup prerequisites & get started with your first cluster, using our AWS CDK sample code. We also provide a quick guide on [How to Deploy MongoDB Atlas with AWS CDK in TypeScript](https://www.mongodb.com/developer/products/atlas/deploy-mongodb-atlas-aws-cdk-typescript/). ## Support, Bugs, Feature Requests Feature requests can be submitted at the [MongoDB feedback portal](https://feedback.mongodb.com/ideas?category=7548141186718564699) - select Atlas -> infra-as-code as the category or vote for an already suggested feature. Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions within the Atlas UI. In addition, support questions submitted under the Issues section of this repo are also being monitored. Bugs should be filed under the Issues section of this repo. ## MongoDB Atlas API Keys Credential Management Atlas API keys Configuration are required for both CloudFormation and CDK resources, and this Atlas API key pair are provided as input by the use of a Profile. AWS CloudFormation limits Third Parties from using non-AWS API Keys as either hardcoded secrets in CloudFormation templates or via CDK, hence we now require all the users store MongoDB Atlas API Keys via [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/). `NOTE: the process for configuring the PROFILE is the same and is required both for CloudFormation and CDK` ### 1. Configure your MongoDB Atlas API Keys You'll need to generate an API key pair (public and private keys) for your Atlas organization and configure them to grant CloudFormation access to your Atlas project. Refer to the [Atlas documentation](https://www.mongodb.com/docs/atlas/configure-api-access/#manage-programmatic-access-to-an-organization) for detailed instructions. ### 2. Configure your Profile To use Atlas CloudFormation resources, you must configure a "profile" with your API keys using [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/). The secret should follow this format: ``` SecretName: cfn/atlas/profile/{ProfileName} SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"} ``` To create a new secret for a default profile, use the [PROFILE SECRET TEMPLATE](/examples/profile-secret.yaml) file provided in this repository. Here are some examples of how to use this template: #### example 1: ``` ProfileName: default SecretName: cfn/atlas/profile/default SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"} ``` #### example 2: ``` ProfileName: testProfile SecretName: cfn/atlas/profile/testProfile SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"} ``` ## Contributing See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. ## Issues ### Autoclose stale issues and PRs - After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 5 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 5 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` - After 5 more days of no activity we automatically close the issue/PR. ### One-click reproducible issues principle Our support will prioritise issues that contain all the required information that follows the following principles: * We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. * This means that you should kindly **provide all the required instructions**. This includes but not limited to: * AWS CDK package version used to reproduce the issue * CFN resource version and AWS region used to reproduce the issue * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed. * Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructor** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: * If other CDK constructors are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. * If external components are required to replicate it, please make sure you also provides instructions on those parts. # API Reference ## Constructs ### AtlasBasic #### Initializers ```typescript import { AtlasBasic } from 'awscdk-resources-mongodbatlas' new AtlasBasic(scope: Construct, id: string, props: AtlasBasicProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AtlasBasicProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AtlasBasicProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AtlasBasic } from 'awscdk-resources-mongodbatlas' AtlasBasic.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | ipAccessList | CfnProjectIpAccessList | *No description.* | | mCluster | CfnCluster | *No description.* | | mDBUser | CfnDatabaseUser | *No description.* | | mProject | CfnProject | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `ipAccessList`^Required ```typescript public readonly ipAccessList: CfnProjectIpAccessList; ``` - *Type:* CfnProjectIpAccessList --- ##### `mCluster`^Required ```typescript public readonly mCluster: CfnCluster; ``` - *Type:* CfnCluster --- ##### `mDBUser`^Required ```typescript public readonly mDBUser: CfnDatabaseUser; ``` - *Type:* CfnDatabaseUser --- ##### `mProject`^Required ```typescript public readonly mProject: CfnProject; ``` - *Type:* CfnProject --- ### AtlasBasicPrivateEndpoint #### Initializers ```typescript import { AtlasBasicPrivateEndpoint } from 'awscdk-resources-mongodbatlas' new AtlasBasicPrivateEndpoint(scope: Construct, id: string, props: AtlasBasicPrivateEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AtlasBasicPrivateEndpointProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AtlasBasicPrivateEndpointProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AtlasBasicPrivateEndpoint } from 'awscdk-resources-mongodbatlas' AtlasBasicPrivateEndpoint.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | atlasBasic | AtlasBasic | *No description.* | | awsPrivateEndpoint | aws-cdk-lib.aws_ec2.CfnVPCEndpoint | *No description.* | | privateEndpointAws | CfnPrivateEndpointAws | *No description.* | | privateEndpointService | CfnPrivateEndpointService | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `atlasBasic`^Required ```typescript public readonly atlasBasic: AtlasBasic; ``` - *Type:* AtlasBasic --- ##### `awsPrivateEndpoint`^Required ```typescript public readonly awsPrivateEndpoint: CfnVPCEndpoint; ``` - *Type:* aws-cdk-lib.aws_ec2.CfnVPCEndpoint --- ##### `privateEndpointAws`^Required ```typescript public readonly privateEndpointAws: CfnPrivateEndpointAws; ``` - *Type:* CfnPrivateEndpointAws --- ##### `privateEndpointService`^Required ```typescript public readonly privateEndpointService: CfnPrivateEndpointService; ``` - *Type:* CfnPrivateEndpointService --- ### AtlasEncryptionAtRest #### Initializers ```typescript import { AtlasEncryptionAtRest } from 'awscdk-resources-mongodbatlas' new AtlasEncryptionAtRest(scope: Construct, id: string, props: AtlasEncryptionAtRestProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AtlasEncryptionAtRestProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AtlasEncryptionAtRestProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AtlasEncryptionAtRest } from 'awscdk-resources-mongodbatlas' AtlasEncryptionAtRest.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnEncryptionAtRest | CfnEncryptionAtRest | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnEncryptionAtRest`^Required ```typescript public readonly cfnEncryptionAtRest: CfnEncryptionAtRest; ``` - *Type:* CfnEncryptionAtRest --- ### AtlasEncryptionAtRestExpress #### Initializers ```typescript import { AtlasEncryptionAtRestExpress } from 'awscdk-resources-mongodbatlas' new AtlasEncryptionAtRestExpress(scope: Construct, id: string, props: AtlasEncryptionAtRestExpressProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AtlasEncryptionAtRestExpressProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AtlasEncryptionAtRestExpressProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AtlasEncryptionAtRestExpress } from 'awscdk-resources-mongodbatlas' AtlasEncryptionAtRestExpress.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | encryptionAtRest | CfnEncryptionAtRest | *No description.* | | accessList | CfnProjectIpAccessList | *No description.* | | cluster | CfnCluster | *No description.* | | databaseUser | CfnDatabaseUser | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `encryptionAtRest`^Required ```typescript public readonly encryptionAtRest: CfnEncryptionAtRest; ``` - *Type:* CfnEncryptionAtRest --- ##### `accessList`^Optional ```typescript public readonly accessList: CfnProjectIpAccessList; ``` - *Type:* CfnProjectIpAccessList --- ##### `cluster`^Optional ```typescript public readonly cluster: CfnCluster; ``` - *Type:* CfnCluster --- ##### `databaseUser`^Optional ```typescript public readonly databaseUser: CfnDatabaseUser; ``` - *Type:* CfnDatabaseUser --- ### CfnAccessListApiKey A CloudFormation `MongoDB::Atlas::AccessListAPIKey`. #### Initializers ```typescript import { CfnAccessListApiKey } from 'awscdk-resources-mongodbatlas' new CfnAccessListApiKey(scope: Construct, id: string, props: CfnAccessListApiKeyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnAccessListApiKeyProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnAccessListApiKeyProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnAccessListApiKey } from 'awscdk-resources-mongodbatlas' CfnAccessListApiKey.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnAccessListApiKey } from 'awscdk-resources-mongodbatlas' CfnAccessListApiKey.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnAccessListApiKey } from 'awscdk-resources-mongodbatlas' CfnAccessListApiKey.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrEntry | string | Attribute `MongoDB::Atlas::AccessListAPIKey.Entry`. | | props | CfnAccessListApiKeyProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrEntry`^Required ```typescript public readonly attrEntry: string; ``` - *Type:* string Attribute `MongoDB::Atlas::AccessListAPIKey.Entry`. --- ##### `props`^Required ```typescript public readonly props: CfnAccessListApiKeyProps; ``` - *Type:* CfnAccessListApiKeyProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnAlertConfiguration A CloudFormation `MongoDB::Atlas::AlertConfiguration`. #### Initializers ```typescript import { CfnAlertConfiguration } from 'awscdk-resources-mongodbatlas' new CfnAlertConfiguration(scope: Construct, id: string, props: CfnAlertConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnAlertConfigurationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnAlertConfigurationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnAlertConfiguration } from 'awscdk-resources-mongodbatlas' CfnAlertConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnAlertConfiguration } from 'awscdk-resources-mongodbatlas' CfnAlertConfiguration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnAlertConfiguration } from 'awscdk-resources-mongodbatlas' CfnAlertConfiguration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreated | string | Attribute `MongoDB::Atlas::AlertConfiguration.Created`. | | attrEnabled | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::AlertConfiguration.Enabled`. | | attrId | string | Attribute `MongoDB::Atlas::AlertConfiguration.Id`. | | attrUpdated | string | Attribute `MongoDB::Atlas::AlertConfiguration.Updated`. | | props | CfnAlertConfigurationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreated`^Required ```typescript public readonly attrCreated: string; ``` - *Type:* string Attribute `MongoDB::Atlas::AlertConfiguration.Created`. --- ##### `attrEnabled`^Required ```typescript public readonly attrEnabled: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::AlertConfiguration.Enabled`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::AlertConfiguration.Id`. --- ##### `attrUpdated`^Required ```typescript public readonly attrUpdated: string; ``` - *Type:* string Attribute `MongoDB::Atlas::AlertConfiguration.Updated`. --- ##### `props`^Required ```typescript public readonly props: CfnAlertConfigurationProps; ``` - *Type:* CfnAlertConfigurationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnApiKey A CloudFormation `MongoDB::Atlas::APIKey`. #### Initializers ```typescript import { CfnApiKey } from 'awscdk-resources-mongodbatlas' new CfnApiKey(scope: Construct, id: string, props: CfnApiKeyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnApiKeyProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnApiKeyProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnApiKey } from 'awscdk-resources-mongodbatlas' CfnApiKey.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnApiKey } from 'awscdk-resources-mongodbatlas' CfnApiKey.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnApiKey } from 'awscdk-resources-mongodbatlas' CfnApiKey.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrAPIUserId | string | Attribute `MongoDB::Atlas::APIKey.APIUserId`. | | attrPrivateKey | string | Attribute `MongoDB::Atlas::APIKey.PrivateKey`. | | attrPublicKey | string | Attribute `MongoDB::Atlas::APIKey.PublicKey`. | | props | CfnApiKeyProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrAPIUserId`^Required ```typescript public readonly attrAPIUserId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::APIKey.APIUserId`. --- ##### `attrPrivateKey`^Required ```typescript public readonly attrPrivateKey: string; ``` - *Type:* string Attribute `MongoDB::Atlas::APIKey.PrivateKey`. --- ##### `attrPublicKey`^Required ```typescript public readonly attrPublicKey: string; ``` - *Type:* string Attribute `MongoDB::Atlas::APIKey.PublicKey`. --- ##### `props`^Required ```typescript public readonly props: CfnApiKeyProps; ``` - *Type:* CfnApiKeyProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnAuditing A CloudFormation `MongoDB::Atlas::Auditing`. #### Initializers ```typescript import { CfnAuditing } from 'awscdk-resources-mongodbatlas' new CfnAuditing(scope: Construct, id: string, props: CfnAuditingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnAuditingProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnAuditingProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnAuditing } from 'awscdk-resources-mongodbatlas' CfnAuditing.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnAuditing } from 'awscdk-resources-mongodbatlas' CfnAuditing.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnAuditing } from 'awscdk-resources-mongodbatlas' CfnAuditing.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrAuditAuthorizationSuccess | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::Auditing.AuditAuthorizationSuccess`. | | attrAuditFilter | string | Attribute `MongoDB::Atlas::Auditing.AuditFilter`. | | attrConfigurationType | string | Attribute `MongoDB::Atlas::Auditing.ConfigurationType`. | | props | CfnAuditingProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrAuditAuthorizationSuccess`^Required ```typescript public readonly attrAuditAuthorizationSuccess: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::Auditing.AuditAuthorizationSuccess`. --- ##### `attrAuditFilter`^Required ```typescript public readonly attrAuditFilter: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Auditing.AuditFilter`. --- ##### `attrConfigurationType`^Required ```typescript public readonly attrConfigurationType: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Auditing.ConfigurationType`. --- ##### `props`^Required ```typescript public readonly props: CfnAuditingProps; ``` - *Type:* CfnAuditingProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnBackupCompliancePolicy A CloudFormation `MongoDB::Atlas::BackupCompliancePolicy`. #### Initializers ```typescript import { CfnBackupCompliancePolicy } from 'awscdk-resources-mongodbatlas' new CfnBackupCompliancePolicy(scope: Construct, id: string, props: CfnBackupCompliancePolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnBackupCompliancePolicyProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnBackupCompliancePolicyProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnBackupCompliancePolicy } from 'awscdk-resources-mongodbatlas' CfnBackupCompliancePolicy.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnBackupCompliancePolicy } from 'awscdk-resources-mongodbatlas' CfnBackupCompliancePolicy.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnBackupCompliancePolicy } from 'awscdk-resources-mongodbatlas' CfnBackupCompliancePolicy.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrState | string | Attribute `MongoDB::Atlas::BackupCompliancePolicy.State`. | | attrUpdatedDate | string | Attribute `MongoDB::Atlas::BackupCompliancePolicy.UpdatedDate`. | | attrUpdatedUser | string | Attribute `MongoDB::Atlas::BackupCompliancePolicy.UpdatedUser`. | | props | CfnBackupCompliancePolicyProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::BackupCompliancePolicy.State`. --- ##### `attrUpdatedDate`^Required ```typescript public readonly attrUpdatedDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::BackupCompliancePolicy.UpdatedDate`. --- ##### `attrUpdatedUser`^Required ```typescript public readonly attrUpdatedUser: string; ``` - *Type:* string Attribute `MongoDB::Atlas::BackupCompliancePolicy.UpdatedUser`. --- ##### `props`^Required ```typescript public readonly props: CfnBackupCompliancePolicyProps; ``` - *Type:* CfnBackupCompliancePolicyProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCloudBackUpRestoreJobs A CloudFormation `MongoDB::Atlas::CloudBackUpRestoreJobs`. #### Initializers ```typescript import { CfnCloudBackUpRestoreJobs } from 'awscdk-resources-mongodbatlas' new CfnCloudBackUpRestoreJobs(scope: Construct, id: string, props: CfnCloudBackUpRestoreJobsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCloudBackUpRestoreJobsProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCloudBackUpRestoreJobsProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCloudBackUpRestoreJobs } from 'awscdk-resources-mongodbatlas' CfnCloudBackUpRestoreJobs.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCloudBackUpRestoreJobs } from 'awscdk-resources-mongodbatlas' CfnCloudBackUpRestoreJobs.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCloudBackUpRestoreJobs } from 'awscdk-resources-mongodbatlas' CfnCloudBackUpRestoreJobs.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCancelled | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Cancelled`. | | attrDeliveryUrl | string[] | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.DeliveryUrl`. | | attrExpired | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Expired`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.ExpiresAt`. | | attrFailed | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Failed`. | | attrFinishedAt | string | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.FinishedAt`. | | attrId | string | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Id`. | | attrTimestamp | string | Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Timestamp`. | | props | CfnCloudBackUpRestoreJobsProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCancelled`^Required ```typescript public readonly attrCancelled: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Cancelled`. --- ##### `attrDeliveryUrl`^Required ```typescript public readonly attrDeliveryUrl: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.DeliveryUrl`. --- ##### `attrExpired`^Required ```typescript public readonly attrExpired: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Expired`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.ExpiresAt`. --- ##### `attrFailed`^Required ```typescript public readonly attrFailed: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Failed`. --- ##### `attrFinishedAt`^Required ```typescript public readonly attrFinishedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.FinishedAt`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Id`. --- ##### `attrTimestamp`^Required ```typescript public readonly attrTimestamp: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Timestamp`. --- ##### `props`^Required ```typescript public readonly props: CfnCloudBackUpRestoreJobsProps; ``` - *Type:* CfnCloudBackUpRestoreJobsProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCloudBackupSchedule A CloudFormation `MongoDB::Atlas::CloudBackupSchedule`. #### Initializers ```typescript import { CfnCloudBackupSchedule } from 'awscdk-resources-mongodbatlas' new CfnCloudBackupSchedule(scope: Construct, id: string, props: CfnCloudBackupScheduleProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCloudBackupScheduleProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCloudBackupScheduleProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCloudBackupSchedule } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSchedule.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCloudBackupSchedule } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSchedule.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCloudBackupSchedule } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSchedule.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrClusterId | string | Attribute `MongoDB::Atlas::CloudBackupSchedule.ClusterId`. | | attrNextSnapshot | string | Attribute `MongoDB::Atlas::CloudBackupSchedule.NextSnapshot`. | | props | CfnCloudBackupScheduleProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrClusterId`^Required ```typescript public readonly attrClusterId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSchedule.ClusterId`. --- ##### `attrNextSnapshot`^Required ```typescript public readonly attrNextSnapshot: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSchedule.NextSnapshot`. --- ##### `props`^Required ```typescript public readonly props: CfnCloudBackupScheduleProps; ``` - *Type:* CfnCloudBackupScheduleProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCloudBackupSnapshot A CloudFormation `MongoDB::Atlas::CloudBackupSnapshot`. #### Initializers ```typescript import { CfnCloudBackupSnapshot } from 'awscdk-resources-mongodbatlas' new CfnCloudBackupSnapshot(scope: Construct, id: string, props: CfnCloudBackupSnapshotProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCloudBackupSnapshotProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCloudBackupSnapshotProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCloudBackupSnapshot } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshot.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCloudBackupSnapshot } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshot.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCloudBackupSnapshot } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshot.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCloudProvider | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.CloudProvider`. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.CreatedAt`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.ExpiresAt`. | | attrId | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.Id`. | | attrMasterKeyUUID | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.MasterKeyUUID`. | | attrMongodVersion | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.MongodVersion`. | | attrReplicaSetName | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.ReplicaSetName`. | | attrSnapshotId | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotId`. | | attrSnapshotIds | string[] | Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotIds`. | | attrStatus | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.Status`. | | attrStorageSizeBytes | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.StorageSizeBytes`. | | attrType | string | Attribute `MongoDB::Atlas::CloudBackupSnapshot.Type`. | | props | CfnCloudBackupSnapshotProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCloudProvider`^Required ```typescript public readonly attrCloudProvider: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.CloudProvider`. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.CreatedAt`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.ExpiresAt`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.Id`. --- ##### `attrMasterKeyUUID`^Required ```typescript public readonly attrMasterKeyUUID: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.MasterKeyUUID`. --- ##### `attrMongodVersion`^Required ```typescript public readonly attrMongodVersion: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.MongodVersion`. --- ##### `attrReplicaSetName`^Required ```typescript public readonly attrReplicaSetName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.ReplicaSetName`. --- ##### `attrSnapshotId`^Required ```typescript public readonly attrSnapshotId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotId`. --- ##### `attrSnapshotIds`^Required ```typescript public readonly attrSnapshotIds: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotIds`. --- ##### `attrStatus`^Required ```typescript public readonly attrStatus: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.Status`. --- ##### `attrStorageSizeBytes`^Required ```typescript public readonly attrStorageSizeBytes: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.StorageSizeBytes`. --- ##### `attrType`^Required ```typescript public readonly attrType: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshot.Type`. --- ##### `props`^Required ```typescript public readonly props: CfnCloudBackupSnapshotProps; ``` - *Type:* CfnCloudBackupSnapshotProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCloudBackupSnapshotExportBucket A CloudFormation `MongoDB::Atlas::CloudBackupSnapshotExportBucket`. #### Initializers ```typescript import { CfnCloudBackupSnapshotExportBucket } from 'awscdk-resources-mongodbatlas' new CfnCloudBackupSnapshotExportBucket(scope: Construct, id: string, props: CfnCloudBackupSnapshotExportBucketProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCloudBackupSnapshotExportBucketProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCloudBackupSnapshotExportBucketProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCloudBackupSnapshotExportBucket } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshotExportBucket.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCloudBackupSnapshotExportBucket } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshotExportBucket.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCloudBackupSnapshotExportBucket } from 'awscdk-resources-mongodbatlas' CfnCloudBackupSnapshotExportBucket.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::CloudBackupSnapshotExportBucket.Id`. | | props | CfnCloudBackupSnapshotExportBucketProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::CloudBackupSnapshotExportBucket.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnCloudBackupSnapshotExportBucketProps; ``` - *Type:* CfnCloudBackupSnapshotExportBucketProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCluster A CloudFormation `MongoDB::Atlas::Cluster`. #### Initializers ```typescript import { CfnCluster } from 'awscdk-resources-mongodbatlas' new CfnCluster(scope: Construct, id: string, props: CfnClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnClusterProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnClusterProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCluster } from 'awscdk-resources-mongodbatlas' CfnCluster.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCluster } from 'awscdk-resources-mongodbatlas' CfnCluster.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCluster } from 'awscdk-resources-mongodbatlas' CfnCluster.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedDate | string | Attribute `MongoDB::Atlas::Cluster.CreatedDate`. | | attrId | string | Attribute `MongoDB::Atlas::Cluster.Id`. | | attrMongoDBVersion | string | Attribute `MongoDB::Atlas::Cluster.MongoDBVersion`. | | attrStateName | string | Attribute `MongoDB::Atlas::Cluster.StateName`. | | props | CfnClusterProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedDate`^Required ```typescript public readonly attrCreatedDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Cluster.CreatedDate`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Cluster.Id`. --- ##### `attrMongoDBVersion`^Required ```typescript public readonly attrMongoDBVersion: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Cluster.MongoDBVersion`. --- ##### `attrStateName`^Required ```typescript public readonly attrStateName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Cluster.StateName`. --- ##### `props`^Required ```typescript public readonly props: CfnClusterProps; ``` - *Type:* CfnClusterProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnClusterOutageSimulation A CloudFormation `MongoDB::Atlas::ClusterOutageSimulation`. #### Initializers ```typescript import { CfnClusterOutageSimulation } from 'awscdk-resources-mongodbatlas' new CfnClusterOutageSimulation(scope: Construct, id: string, props: CfnClusterOutageSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnClusterOutageSimulationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnClusterOutageSimulationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnClusterOutageSimulation } from 'awscdk-resources-mongodbatlas' CfnClusterOutageSimulation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnClusterOutageSimulation } from 'awscdk-resources-mongodbatlas' CfnClusterOutageSimulation.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnClusterOutageSimulation } from 'awscdk-resources-mongodbatlas' CfnClusterOutageSimulation.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrSimulationId | string | Attribute `MongoDB::Atlas::ClusterOutageSimulation.SimulationId`. | | attrStartRequestDate | string | Attribute `MongoDB::Atlas::ClusterOutageSimulation.StartRequestDate`. | | attrState | string | Attribute `MongoDB::Atlas::ClusterOutageSimulation.State`. | | props | CfnClusterOutageSimulationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrSimulationId`^Required ```typescript public readonly attrSimulationId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ClusterOutageSimulation.SimulationId`. --- ##### `attrStartRequestDate`^Required ```typescript public readonly attrStartRequestDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ClusterOutageSimulation.StartRequestDate`. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ClusterOutageSimulation.State`. --- ##### `props`^Required ```typescript public readonly props: CfnClusterOutageSimulationProps; ``` - *Type:* CfnClusterOutageSimulationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCustomDbRole A CloudFormation `MongoDB::Atlas::CustomDBRole`. #### Initializers ```typescript import { CfnCustomDbRole } from 'awscdk-resources-mongodbatlas' new CfnCustomDbRole(scope: Construct, id: string, props: CfnCustomDbRoleProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCustomDbRoleProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCustomDbRoleProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCustomDbRole } from 'awscdk-resources-mongodbatlas' CfnCustomDbRole.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCustomDbRole } from 'awscdk-resources-mongodbatlas' CfnCustomDbRole.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCustomDbRole } from 'awscdk-resources-mongodbatlas' CfnCustomDbRole.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnCustomDbRoleProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnCustomDbRoleProps; ``` - *Type:* CfnCustomDbRoleProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnCustomDnsConfigurationClusterAws A CloudFormation `MongoDB::Atlas::CustomDnsConfigurationClusterAws`. #### Initializers ```typescript import { CfnCustomDnsConfigurationClusterAws } from 'awscdk-resources-mongodbatlas' new CfnCustomDnsConfigurationClusterAws(scope: Construct, id: string, props: CfnCustomDnsConfigurationClusterAwsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnCustomDnsConfigurationClusterAwsProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnCustomDnsConfigurationClusterAwsProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnCustomDnsConfigurationClusterAws } from 'awscdk-resources-mongodbatlas' CfnCustomDnsConfigurationClusterAws.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnCustomDnsConfigurationClusterAws } from 'awscdk-resources-mongodbatlas' CfnCustomDnsConfigurationClusterAws.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCustomDnsConfigurationClusterAws } from 'awscdk-resources-mongodbatlas' CfnCustomDnsConfigurationClusterAws.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnCustomDnsConfigurationClusterAwsProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnCustomDnsConfigurationClusterAwsProps; ``` - *Type:* CfnCustomDnsConfigurationClusterAwsProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnDatabaseUser A CloudFormation `MongoDB::Atlas::DatabaseUser`. #### Initializers ```typescript import { CfnDatabaseUser } from 'awscdk-resources-mongodbatlas' new CfnDatabaseUser(scope: Construct, id: string, props: CfnDatabaseUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnDatabaseUserProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnDatabaseUserProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnDatabaseUser.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnDatabaseUser.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnDatabaseUser.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrUserCFNIdentifier | string | Attribute `MongoDB::Atlas::DatabaseUser.UserCFNIdentifier`. | | props | CfnDatabaseUserProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrUserCFNIdentifier`^Required ```typescript public readonly attrUserCFNIdentifier: string; ``` - *Type:* string Attribute `MongoDB::Atlas::DatabaseUser.UserCFNIdentifier`. --- ##### `props`^Required ```typescript public readonly props: CfnDatabaseUserProps; ``` - *Type:* CfnDatabaseUserProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnEncryptionAtRest A CloudFormation `MongoDB::Atlas::EncryptionAtRest`. #### Initializers ```typescript import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' new CfnEncryptionAtRest(scope: Construct, id: string, props: CfnEncryptionAtRestProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnEncryptionAtRestProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnEncryptionAtRestProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' CfnEncryptionAtRest.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' CfnEncryptionAtRest.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' CfnEncryptionAtRest.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. | | props | CfnEncryptionAtRestProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnEncryptionAtRestProps; ``` - *Type:* CfnEncryptionAtRestProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnFederatedDatabaseInstance A CloudFormation `MongoDB::Atlas::FederatedDatabaseInstance`. #### Initializers ```typescript import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' new CfnFederatedDatabaseInstance(scope: Construct, id: string, props: CfnFederatedDatabaseInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnFederatedDatabaseInstanceProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnFederatedDatabaseInstanceProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' CfnFederatedDatabaseInstance.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' CfnFederatedDatabaseInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' CfnFederatedDatabaseInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrHostNames | string[] | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. | | attrState | string | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. | | props | CfnFederatedDatabaseInstanceProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrHostNames`^Required ```typescript public readonly attrHostNames: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. --- ##### `props`^Required ```typescript public readonly props: CfnFederatedDatabaseInstanceProps; ``` - *Type:* CfnFederatedDatabaseInstanceProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnFederatedQueryLimit A CloudFormation `MongoDB::Atlas::FederatedQueryLimit`. #### Initializers ```typescript import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' new CfnFederatedQueryLimit(scope: Construct, id: string, props: CfnFederatedQueryLimitProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnFederatedQueryLimitProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnFederatedQueryLimitProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' CfnFederatedQueryLimit.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' CfnFederatedQueryLimit.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' CfnFederatedQueryLimit.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCurrentUsage | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. | | attrDefaultLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. | | attrLastModifiedDate | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. | | attrMaximumLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. | | props | CfnFederatedQueryLimitProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCurrentUsage`^Required ```typescript public readonly attrCurrentUsage: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. --- ##### `attrDefaultLimit`^Required ```typescript public readonly attrDefaultLimit: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. --- ##### `attrLastModifiedDate`^Required ```typescript public readonly attrLastModifiedDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. --- ##### `attrMaximumLimit`^Required ```typescript public readonly attrMaximumLimit: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. --- ##### `props`^Required ```typescript public readonly props: CfnFederatedQueryLimitProps; ``` - *Type:* CfnFederatedQueryLimitProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnFederatedSettingsIdentityProvider A CloudFormation `MongoDB::Atlas::FederatedSettingsIdentityProvider`. #### Initializers ```typescript import { CfnFederatedSettingsIdentityProvider } from 'awscdk-resources-mongodbatlas' new CfnFederatedSettingsIdentityProvider(scope: Construct, id: string, props: CfnFederatedSettingsIdentityProviderProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnFederatedSettingsIdentityProviderProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnFederatedSettingsIdentityProviderProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnFederatedSettingsIdentityProvider } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsIdentityProvider.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnFederatedSettingsIdentityProvider } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsIdentityProvider.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnFederatedSettingsIdentityProvider } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsIdentityProvider.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrIdpId | string | Attribute `MongoDB::Atlas::FederatedSettingsIdentityProvider.IdpId`. | | attrOktaIdpId | string | Attribute `MongoDB::Atlas::FederatedSettingsIdentityProvider.OktaIdpId`. | | props | CfnFederatedSettingsIdentityProviderProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrIdpId`^Required ```typescript public readonly attrIdpId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedSettingsIdentityProvider.IdpId`. --- ##### `attrOktaIdpId`^Required ```typescript public readonly attrOktaIdpId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedSettingsIdentityProvider.OktaIdpId`. --- ##### `props`^Required ```typescript public readonly props: CfnFederatedSettingsIdentityProviderProps; ``` - *Type:* CfnFederatedSettingsIdentityProviderProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnFederatedSettingsOrgRoleMapping A CloudFormation `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`. #### Initializers ```typescript import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' new CfnFederatedSettingsOrgRoleMapping(scope: Construct, id: string, props: CfnFederatedSettingsOrgRoleMappingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnFederatedSettingsOrgRoleMappingProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnFederatedSettingsOrgRoleMappingProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsOrgRoleMapping.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsOrgRoleMapping.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' CfnFederatedSettingsOrgRoleMapping.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. | | props | CfnFederatedSettingsOrgRoleMappingProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnFederatedSettingsOrgRoleMappingProps; ``` - *Type:* CfnFederatedSettingsOrgRoleMappingProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnFlexCluster A CloudFormation `MongoDB::Atlas::FlexCluster`. #### Initializers ```typescript import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' new CfnFlexCluster(scope: Construct, id: string, props: CfnFlexClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnFlexClusterProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnFlexClusterProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' CfnFlexCluster.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' CfnFlexCluster.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' CfnFlexCluster.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrClusterType | string | Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. | | attrCreateDate | string | Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. | | attrId | string | Attribute `MongoDB::Atlas::FlexCluster.Id`. | | attrMongoDBVersion | string | Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. | | attrStateName | string | Attribute `MongoDB::Atlas::FlexCluster.StateName`. | | attrVersionReleaseSystem | string | Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. | | props | CfnFlexClusterProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrClusterType`^Required ```typescript public readonly attrClusterType: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. --- ##### `attrCreateDate`^Required ```typescript public readonly attrCreateDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.Id`. --- ##### `attrMongoDBVersion`^Required ```typescript public readonly attrMongoDBVersion: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. --- ##### `attrStateName`^Required ```typescript public readonly attrStateName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.StateName`. --- ##### `attrVersionReleaseSystem`^Required ```typescript public readonly attrVersionReleaseSystem: string; ``` - *Type:* string Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. --- ##### `props`^Required ```typescript public readonly props: CfnFlexClusterProps; ``` - *Type:* CfnFlexClusterProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnGlobalClusterConfig A CloudFormation `MongoDB::Atlas::GlobalClusterConfig`. #### Initializers ```typescript import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' new CfnGlobalClusterConfig(scope: Construct, id: string, props: CfnGlobalClusterConfigProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnGlobalClusterConfigProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnGlobalClusterConfigProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' CfnGlobalClusterConfig.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' CfnGlobalClusterConfig.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' CfnGlobalClusterConfig.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrRemoveAllZoneMapping | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. | | props | CfnGlobalClusterConfigProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrRemoveAllZoneMapping`^Required ```typescript public readonly attrRemoveAllZoneMapping: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. --- ##### `props`^Required ```typescript public readonly props: CfnGlobalClusterConfigProps; ``` - *Type:* CfnGlobalClusterConfigProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnLdapConfiguration A CloudFormation `MongoDB::Atlas::LDAPConfiguration`. #### Initializers ```typescript import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' new CfnLdapConfiguration(scope: Construct, id: string, props: CfnLdapConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnLdapConfigurationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnLdapConfigurationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' CfnLdapConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' CfnLdapConfiguration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' CfnLdapConfiguration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnLdapConfigurationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnLdapConfigurationProps; ``` - *Type:* CfnLdapConfigurationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnLdapVerify A CloudFormation `MongoDB::Atlas::LDAPVerify`. #### Initializers ```typescript import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' new CfnLdapVerify(scope: Construct, id: string, props: CfnLdapVerifyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnLdapVerifyProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnLdapVerifyProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' CfnLdapVerify.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' CfnLdapVerify.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' CfnLdapVerify.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrRequestId | string | Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. | | attrStatus | string | Attribute `MongoDB::Atlas::LDAPVerify.Status`. | | props | CfnLdapVerifyProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrRequestId`^Required ```typescript public readonly attrRequestId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. --- ##### `attrStatus`^Required ```typescript public readonly attrStatus: string; ``` - *Type:* string Attribute `MongoDB::Atlas::LDAPVerify.Status`. --- ##### `props`^Required ```typescript public readonly props: CfnLdapVerifyProps; ``` - *Type:* CfnLdapVerifyProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnLogIntegration A CloudFormation `MongoDB::Atlas::LogIntegration`. #### Initializers ```typescript import { CfnLogIntegration } from 'awscdk-resources-mongodbatlas' new CfnLogIntegration(scope: Construct, id: string, props: CfnLogIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnLogIntegrationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnLogIntegrationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnLogIntegration } from 'awscdk-resources-mongodbatlas' CfnLogIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnLogIntegration } from 'awscdk-resources-mongodbatlas' CfnLogIntegration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnLogIntegration } from 'awscdk-resources-mongodbatlas' CfnLogIntegration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrIntegrationId | string | Attribute `MongoDB::Atlas::LogIntegration.IntegrationId`. | | props | CfnLogIntegrationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrIntegrationId`^Required ```typescript public readonly attrIntegrationId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::LogIntegration.IntegrationId`. --- ##### `props`^Required ```typescript public readonly props: CfnLogIntegrationProps; ``` - *Type:* CfnLogIntegrationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnMaintenanceWindow A CloudFormation `MongoDB::Atlas::MaintenanceWindow`. #### Initializers ```typescript import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' new CfnMaintenanceWindow(scope: Construct, id: string, props: CfnMaintenanceWindowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnMaintenanceWindowProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnMaintenanceWindowProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' CfnMaintenanceWindow.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' CfnMaintenanceWindow.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' CfnMaintenanceWindow.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrNumberOfDeferrals | number | Attribute `MongoDB::Atlas::MaintenanceWindow.NumberOfDeferrals`. | | attrStartASAP | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::MaintenanceWindow.StartASAP`. | | attrTimeZoneId | string | Attribute `MongoDB::Atlas::MaintenanceWindow.TimeZoneId`. | | props | CfnMaintenanceWindowProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrNumberOfDeferrals`^Required ```typescript public readonly attrNumberOfDeferrals: number; ``` - *Type:* number Attribute `MongoDB::Atlas::MaintenanceWindow.NumberOfDeferrals`. --- ##### `attrStartASAP`^Required ```typescript public readonly attrStartASAP: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::MaintenanceWindow.StartASAP`. --- ##### `attrTimeZoneId`^Required ```typescript public readonly attrTimeZoneId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::MaintenanceWindow.TimeZoneId`. --- ##### `props`^Required ```typescript public readonly props: CfnMaintenanceWindowProps; ``` - *Type:* CfnMaintenanceWindowProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnMongoDbEmployeeAccessGrant A CloudFormation `MongoDB::Atlas::MongoDbEmployeeAccessGrant`. #### Initializers ```typescript import { CfnMongoDbEmployeeAccessGrant } from 'awscdk-resources-mongodbatlas' new CfnMongoDbEmployeeAccessGrant(scope: Construct, id: string, props: CfnMongoDbEmployeeAccessGrantProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnMongoDbEmployeeAccessGrantProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnMongoDbEmployeeAccessGrantProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnMongoDbEmployeeAccessGrant } from 'awscdk-resources-mongodbatlas' CfnMongoDbEmployeeAccessGrant.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnMongoDbEmployeeAccessGrant } from 'awscdk-resources-mongodbatlas' CfnMongoDbEmployeeAccessGrant.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnMongoDbEmployeeAccessGrant } from 'awscdk-resources-mongodbatlas' CfnMongoDbEmployeeAccessGrant.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnMongoDbEmployeeAccessGrantProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnMongoDbEmployeeAccessGrantProps; ``` - *Type:* CfnMongoDbEmployeeAccessGrantProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnNetworkContainer A CloudFormation `MongoDB::Atlas::NetworkContainer`. #### Initializers ```typescript import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' new CfnNetworkContainer(scope: Construct, id: string, props: CfnNetworkContainerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnNetworkContainerProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnNetworkContainerProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' CfnNetworkContainer.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' CfnNetworkContainer.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' CfnNetworkContainer.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::NetworkContainer.Id`. | | props | CfnNetworkContainerProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::NetworkContainer.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnNetworkContainerProps; ``` - *Type:* CfnNetworkContainerProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnNetworkPeering A CloudFormation `MongoDB::Atlas::NetworkPeering`. #### Initializers ```typescript import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' new CfnNetworkPeering(scope: Construct, id: string, props: CfnNetworkPeeringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnNetworkPeeringProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnNetworkPeeringProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' CfnNetworkPeering.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' CfnNetworkPeering.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' CfnNetworkPeering.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrConnectionId | string | Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. | | attrErrorStateName | string | Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. | | attrId | string | Attribute `MongoDB::Atlas::NetworkPeering.Id`. | | attrStatusName | string | Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. | | props | CfnNetworkPeeringProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrConnectionId`^Required ```typescript public readonly attrConnectionId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. --- ##### `attrErrorStateName`^Required ```typescript public readonly attrErrorStateName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::NetworkPeering.Id`. --- ##### `attrStatusName`^Required ```typescript public readonly attrStatusName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. --- ##### `props`^Required ```typescript public readonly props: CfnNetworkPeeringProps; ``` - *Type:* CfnNetworkPeeringProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnOnlineArchive A CloudFormation `MongoDB::Atlas::OnlineArchive`. #### Initializers ```typescript import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' new CfnOnlineArchive(scope: Construct, id: string, props: CfnOnlineArchiveProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnOnlineArchiveProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnOnlineArchiveProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnOnlineArchive.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnOnlineArchive.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnOnlineArchive.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrArchiveId | string | Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. | | attrState | string | Attribute `MongoDB::Atlas::OnlineArchive.State`. | | attrTotalCount | number | Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. | | props | CfnOnlineArchiveProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrArchiveId`^Required ```typescript public readonly attrArchiveId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OnlineArchive.State`. --- ##### `attrTotalCount`^Required ```typescript public readonly attrTotalCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. --- ##### `props`^Required ```typescript public readonly props: CfnOnlineArchiveProps; ``` - *Type:* CfnOnlineArchiveProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnOrganization A CloudFormation `MongoDB::Atlas::Organization`. #### Initializers ```typescript import { CfnOrganization } from 'awscdk-resources-mongodbatlas' new CfnOrganization(scope: Construct, id: string, props: CfnOrganizationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnOrganizationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnOrganizationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnOrganization } from 'awscdk-resources-mongodbatlas' CfnOrganization.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnOrganization } from 'awscdk-resources-mongodbatlas' CfnOrganization.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnOrganization } from 'awscdk-resources-mongodbatlas' CfnOrganization.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrOrgId | string | Attribute `MongoDB::Atlas::Organization.OrgId`. | | props | CfnOrganizationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrOrgId`^Required ```typescript public readonly attrOrgId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Organization.OrgId`. --- ##### `props`^Required ```typescript public readonly props: CfnOrganizationProps; ``` - *Type:* CfnOrganizationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnOrgInvitation A CloudFormation `MongoDB::Atlas::OrgInvitation`. #### Initializers ```typescript import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' new CfnOrgInvitation(scope: Construct, id: string, props: CfnOrgInvitationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnOrgInvitationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnOrgInvitationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' CfnOrgInvitation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' CfnOrgInvitation.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' CfnOrgInvitation.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. | | attrId | string | Attribute `MongoDB::Atlas::OrgInvitation.Id`. | | attrInviterUsername | string | Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. | | props | CfnOrgInvitationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OrgInvitation.Id`. --- ##### `attrInviterUsername`^Required ```typescript public readonly attrInviterUsername: string; ``` - *Type:* string Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. --- ##### `props`^Required ```typescript public readonly props: CfnOrgInvitationProps; ``` - *Type:* CfnOrgInvitationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnPrivateEndpoint A CloudFormation `MongoDB::Atlas::PrivateEndpoint`. #### Initializers ```typescript import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' new CfnPrivateEndpoint(scope: Construct, id: string, props: CfnPrivateEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnPrivateEndpointProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnPrivateEndpointProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpoint.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpoint.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpoint.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. | | attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. | | props | CfnPrivateEndpointProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. --- ##### `attrInterfaceEndpoints`^Required ```typescript public readonly attrInterfaceEndpoints: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. --- ##### `props`^Required ```typescript public readonly props: CfnPrivateEndpointProps; ``` - *Type:* CfnPrivateEndpointProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnPrivateEndpointAws A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`. #### Initializers ```typescript import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' new CfnPrivateEndpointAws(scope: Construct, id: string, props: CfnPrivateEndpointAwsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnPrivateEndpointAwsProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnPrivateEndpointAwsProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointAws.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointAws.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointAws.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrConnectionStatus | string | Attribute `MongoDB::Atlas::PrivateEndpointAWS.ConnectionStatus`. | | attrDeleteRequested | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::PrivateEndpointAWS.DeleteRequested`. | | attrErrorMessage | string | Attribute `MongoDB::Atlas::PrivateEndpointAWS.ErrorMessage`. | | attrInterfaceEndpointId | string | Attribute `MongoDB::Atlas::PrivateEndpointAWS.InterfaceEndpointId`. | | props | CfnPrivateEndpointAwsProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrConnectionStatus`^Required ```typescript public readonly attrConnectionStatus: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointAWS.ConnectionStatus`. --- ##### `attrDeleteRequested`^Required ```typescript public readonly attrDeleteRequested: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable Attribute `MongoDB::Atlas::PrivateEndpointAWS.DeleteRequested`. --- ##### `attrErrorMessage`^Required ```typescript public readonly attrErrorMessage: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointAWS.ErrorMessage`. --- ##### `attrInterfaceEndpointId`^Required ```typescript public readonly attrInterfaceEndpointId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointAWS.InterfaceEndpointId`. --- ##### `props`^Required ```typescript public readonly props: CfnPrivateEndpointAwsProps; ``` - *Type:* CfnPrivateEndpointAwsProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnPrivateEndPointRegionalMode A CloudFormation `MongoDB::Atlas::PrivateEndPointRegionalMode`. #### Initializers ```typescript import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' new CfnPrivateEndPointRegionalMode(scope: Construct, id: string, props: CfnPrivateEndPointRegionalModeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnPrivateEndPointRegionalModeProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnPrivateEndPointRegionalModeProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' CfnPrivateEndPointRegionalMode.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' CfnPrivateEndPointRegionalMode.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' CfnPrivateEndPointRegionalMode.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnPrivateEndPointRegionalModeProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnPrivateEndPointRegionalModeProps; ``` - *Type:* CfnPrivateEndPointRegionalModeProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnPrivateEndpointService A CloudFormation `MongoDB::Atlas::PrivateEndpointService`. #### Initializers ```typescript import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' new CfnPrivateEndpointService(scope: Construct, id: string, props: CfnPrivateEndpointServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnPrivateEndpointServiceProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnPrivateEndpointServiceProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointService.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointService.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' CfnPrivateEndpointService.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrEndpointServiceName | string | Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. | | attrErrorMessage | string | Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. | | attrId | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. | | attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. | | attrStatus | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. | | props | CfnPrivateEndpointServiceProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrEndpointServiceName`^Required ```typescript public readonly attrEndpointServiceName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. --- ##### `attrErrorMessage`^Required ```typescript public readonly attrErrorMessage: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. --- ##### `attrInterfaceEndpoints`^Required ```typescript public readonly attrInterfaceEndpoints: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. --- ##### `attrStatus`^Required ```typescript public readonly attrStatus: string; ``` - *Type:* string Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. --- ##### `props`^Required ```typescript public readonly props: CfnPrivateEndpointServiceProps; ``` - *Type:* CfnPrivateEndpointServiceProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnPrivatelinkEndpointServiceDataFederationOnlineArchive A CloudFormation `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`. #### Initializers ```typescript import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' new CfnPrivatelinkEndpointServiceDataFederationOnlineArchive(scope: Construct, id: string, props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps; ``` - *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProject A CloudFormation `MongoDB::Atlas::Project`. #### Initializers ```typescript import { CfnProject } from 'awscdk-resources-mongodbatlas' new CfnProject(scope: Construct, id: string, props: CfnProjectProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProject } from 'awscdk-resources-mongodbatlas' CfnProject.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProject } from 'awscdk-resources-mongodbatlas' CfnProject.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProject } from 'awscdk-resources-mongodbatlas' CfnProject.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrClusterCount | number | Attribute `MongoDB::Atlas::Project.ClusterCount`. | | attrCreated | string | Attribute `MongoDB::Atlas::Project.Created`. | | attrId | string | Attribute `MongoDB::Atlas::Project.Id`. | | props | CfnProjectProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrClusterCount`^Required ```typescript public readonly attrClusterCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::Project.ClusterCount`. --- ##### `attrCreated`^Required ```typescript public readonly attrCreated: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Project.Created`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Project.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectProps; ``` - *Type:* CfnProjectProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProjectInvitation A CloudFormation `MongoDB::Atlas::ProjectInvitation`. #### Initializers ```typescript import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' new CfnProjectInvitation(scope: Construct, id: string, props: CfnProjectInvitationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectInvitationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectInvitationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' CfnProjectInvitation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' CfnProjectInvitation.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' CfnProjectInvitation.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. | | attrId | string | Attribute `MongoDB::Atlas::ProjectInvitation.Id`. | | attrInviterUsername | string | Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. | | props | CfnProjectInvitationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectInvitation.Id`. --- ##### `attrInviterUsername`^Required ```typescript public readonly attrInviterUsername: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectInvitationProps; ``` - *Type:* CfnProjectInvitationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProjectIpAccessList A CloudFormation `MongoDB::Atlas::ProjectIpAccessList`. #### Initializers ```typescript import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' new CfnProjectIpAccessList(scope: Construct, id: string, props: CfnProjectIpAccessListProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectIpAccessListProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectIpAccessListProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' CfnProjectIpAccessList.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' CfnProjectIpAccessList.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' CfnProjectIpAccessList.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrTotalCount | number | Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. | | props | CfnProjectIpAccessListProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrTotalCount`^Required ```typescript public readonly attrTotalCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectIpAccessListProps; ``` - *Type:* CfnProjectIpAccessListProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProjectServiceAccount A CloudFormation `MongoDB::Atlas::ProjectServiceAccount`. #### Initializers ```typescript import { CfnProjectServiceAccount } from 'awscdk-resources-mongodbatlas' new CfnProjectServiceAccount(scope: Construct, id: string, props: CfnProjectServiceAccountProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectServiceAccountProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectServiceAccountProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProjectServiceAccount } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccount.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProjectServiceAccount } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccount.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProjectServiceAccount } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccount.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrClientId | string | Attribute `MongoDB::Atlas::ProjectServiceAccount.ClientId`. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccount.CreatedAt`. | | props | CfnProjectServiceAccountProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrClientId`^Required ```typescript public readonly attrClientId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccount.ClientId`. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccount.CreatedAt`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectServiceAccountProps; ``` - *Type:* CfnProjectServiceAccountProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProjectServiceAccountAccessListEntry A CloudFormation `MongoDB::Atlas::ProjectServiceAccountAccessListEntry`. #### Initializers ```typescript import { CfnProjectServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' new CfnProjectServiceAccountAccessListEntry(scope: Construct, id: string, props: CfnProjectServiceAccountAccessListEntryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectServiceAccountAccessListEntryProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectServiceAccountAccessListEntryProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProjectServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountAccessListEntry.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProjectServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountAccessListEntry.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProjectServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountAccessListEntry.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.CreatedAt`. | | attrLastUsedAddress | string | Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.LastUsedAddress`. | | attrLastUsedAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.LastUsedAt`. | | attrRequestCount | number | Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.RequestCount`. | | props | CfnProjectServiceAccountAccessListEntryProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.CreatedAt`. --- ##### `attrLastUsedAddress`^Required ```typescript public readonly attrLastUsedAddress: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.LastUsedAddress`. --- ##### `attrLastUsedAt`^Required ```typescript public readonly attrLastUsedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.LastUsedAt`. --- ##### `attrRequestCount`^Required ```typescript public readonly attrRequestCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::ProjectServiceAccountAccessListEntry.RequestCount`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectServiceAccountAccessListEntryProps; ``` - *Type:* CfnProjectServiceAccountAccessListEntryProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnProjectServiceAccountSecret A CloudFormation `MongoDB::Atlas::ProjectServiceAccountSecret`. #### Initializers ```typescript import { CfnProjectServiceAccountSecret } from 'awscdk-resources-mongodbatlas' new CfnProjectServiceAccountSecret(scope: Construct, id: string, props: CfnProjectServiceAccountSecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnProjectServiceAccountSecretProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnProjectServiceAccountSecretProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnProjectServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountSecret.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnProjectServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountSecret.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnProjectServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnProjectServiceAccountSecret.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.CreatedAt`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.ExpiresAt`. | | attrLastUsedAt | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.LastUsedAt`. | | attrMaskedSecretValue | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.MaskedSecretValue`. | | attrSecret | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.Secret`. | | attrSecretId | string | Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.SecretId`. | | props | CfnProjectServiceAccountSecretProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.CreatedAt`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.ExpiresAt`. --- ##### `attrLastUsedAt`^Required ```typescript public readonly attrLastUsedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.LastUsedAt`. --- ##### `attrMaskedSecretValue`^Required ```typescript public readonly attrMaskedSecretValue: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.MaskedSecretValue`. --- ##### `attrSecret`^Required ```typescript public readonly attrSecret: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.Secret`. --- ##### `attrSecretId`^Required ```typescript public readonly attrSecretId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ProjectServiceAccountSecret.SecretId`. --- ##### `props`^Required ```typescript public readonly props: CfnProjectServiceAccountSecretProps; ``` - *Type:* CfnProjectServiceAccountSecretProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnResourcePolicy A CloudFormation `MongoDB::Atlas::ResourcePolicy`. #### Initializers ```typescript import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' new CfnResourcePolicy(scope: Construct, id: string, props: CfnResourcePolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnResourcePolicyProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnResourcePolicyProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' CfnResourcePolicy.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' CfnResourcePolicy.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' CfnResourcePolicy.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. | | attrId | string | Attribute `MongoDB::Atlas::ResourcePolicy.Id`. | | attrLastUpdatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. | | attrVersion | string | Attribute `MongoDB::Atlas::ResourcePolicy.Version`. | | props | CfnResourcePolicyProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedDate`^Required ```typescript public readonly attrCreatedDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ResourcePolicy.Id`. --- ##### `attrLastUpdatedDate`^Required ```typescript public readonly attrLastUpdatedDate: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. --- ##### `attrVersion`^Required ```typescript public readonly attrVersion: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ResourcePolicy.Version`. --- ##### `props`^Required ```typescript public readonly props: CfnResourcePolicyProps; ``` - *Type:* CfnResourcePolicyProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnSearchDeployment A CloudFormation `MongoDB::Atlas::SearchDeployment`. #### Initializers ```typescript import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' new CfnSearchDeployment(scope: Construct, id: string, props: CfnSearchDeploymentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnSearchDeploymentProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnSearchDeploymentProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' CfnSearchDeployment.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' CfnSearchDeployment.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' CfnSearchDeployment.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrEncryptionAtRestProvider | string | Attribute `MongoDB::Atlas::SearchDeployment.EncryptionAtRestProvider`. | | attrId | string | Attribute `MongoDB::Atlas::SearchDeployment.Id`. | | attrStateName | string | Attribute `MongoDB::Atlas::SearchDeployment.StateName`. | | props | CfnSearchDeploymentProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrEncryptionAtRestProvider`^Required ```typescript public readonly attrEncryptionAtRestProvider: string; ``` - *Type:* string Attribute `MongoDB::Atlas::SearchDeployment.EncryptionAtRestProvider`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::SearchDeployment.Id`. --- ##### `attrStateName`^Required ```typescript public readonly attrStateName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::SearchDeployment.StateName`. --- ##### `props`^Required ```typescript public readonly props: CfnSearchDeploymentProps; ``` - *Type:* CfnSearchDeploymentProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnSearchIndex A CloudFormation `MongoDB::Atlas::SearchIndex`. #### Initializers ```typescript import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' new CfnSearchIndex(scope: Construct, id: string, props: CfnSearchIndexProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnSearchIndexProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnSearchIndexProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' CfnSearchIndex.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' CfnSearchIndex.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' CfnSearchIndex.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrIndexId | string | Attribute `MongoDB::Atlas::SearchIndex.IndexId`. | | attrStatus | string | Attribute `MongoDB::Atlas::SearchIndex.Status`. | | props | CfnSearchIndexProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrIndexId`^Required ```typescript public readonly attrIndexId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::SearchIndex.IndexId`. --- ##### `attrStatus`^Required ```typescript public readonly attrStatus: string; ``` - *Type:* string Attribute `MongoDB::Atlas::SearchIndex.Status`. --- ##### `props`^Required ```typescript public readonly props: CfnSearchIndexProps; ``` - *Type:* CfnSearchIndexProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnServiceAccount A CloudFormation `MongoDB::Atlas::ServiceAccount`. #### Initializers ```typescript import { CfnServiceAccount } from 'awscdk-resources-mongodbatlas' new CfnServiceAccount(scope: Construct, id: string, props: CfnServiceAccountProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnServiceAccountProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnServiceAccountProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnServiceAccount } from 'awscdk-resources-mongodbatlas' CfnServiceAccount.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnServiceAccount } from 'awscdk-resources-mongodbatlas' CfnServiceAccount.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnServiceAccount } from 'awscdk-resources-mongodbatlas' CfnServiceAccount.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrClientId | string | Attribute `MongoDB::Atlas::ServiceAccount.ClientId`. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ServiceAccount.CreatedAt`. | | props | CfnServiceAccountProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrClientId`^Required ```typescript public readonly attrClientId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccount.ClientId`. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccount.CreatedAt`. --- ##### `props`^Required ```typescript public readonly props: CfnServiceAccountProps; ``` - *Type:* CfnServiceAccountProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnServiceAccountAccessListEntry A CloudFormation `MongoDB::Atlas::ServiceAccountAccessListEntry`. #### Initializers ```typescript import { CfnServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' new CfnServiceAccountAccessListEntry(scope: Construct, id: string, props: CfnServiceAccountAccessListEntryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnServiceAccountAccessListEntryProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnServiceAccountAccessListEntryProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnServiceAccountAccessListEntry.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnServiceAccountAccessListEntry.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnServiceAccountAccessListEntry } from 'awscdk-resources-mongodbatlas' CfnServiceAccountAccessListEntry.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.CreatedAt`. | | attrLastUsedAddress | string | Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.LastUsedAddress`. | | attrLastUsedAt | string | Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.LastUsedAt`. | | attrRequestCount | number | Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.RequestCount`. | | props | CfnServiceAccountAccessListEntryProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.CreatedAt`. --- ##### `attrLastUsedAddress`^Required ```typescript public readonly attrLastUsedAddress: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.LastUsedAddress`. --- ##### `attrLastUsedAt`^Required ```typescript public readonly attrLastUsedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.LastUsedAt`. --- ##### `attrRequestCount`^Required ```typescript public readonly attrRequestCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::ServiceAccountAccessListEntry.RequestCount`. --- ##### `props`^Required ```typescript public readonly props: CfnServiceAccountAccessListEntryProps; ``` - *Type:* CfnServiceAccountAccessListEntryProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnServiceAccountProjectAssignment A CloudFormation `MongoDB::Atlas::ServiceAccountProjectAssignment`. #### Initializers ```typescript import { CfnServiceAccountProjectAssignment } from 'awscdk-resources-mongodbatlas' new CfnServiceAccountProjectAssignment(scope: Construct, id: string, props: CfnServiceAccountProjectAssignmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnServiceAccountProjectAssignmentProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnServiceAccountProjectAssignmentProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnServiceAccountProjectAssignment } from 'awscdk-resources-mongodbatlas' CfnServiceAccountProjectAssignment.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnServiceAccountProjectAssignment } from 'awscdk-resources-mongodbatlas' CfnServiceAccountProjectAssignment.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnServiceAccountProjectAssignment } from 'awscdk-resources-mongodbatlas' CfnServiceAccountProjectAssignment.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnServiceAccountProjectAssignmentProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnServiceAccountProjectAssignmentProps; ``` - *Type:* CfnServiceAccountProjectAssignmentProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnServiceAccountSecret A CloudFormation `MongoDB::Atlas::ServiceAccountSecret`. #### Initializers ```typescript import { CfnServiceAccountSecret } from 'awscdk-resources-mongodbatlas' new CfnServiceAccountSecret(scope: Construct, id: string, props: CfnServiceAccountSecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnServiceAccountSecretProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnServiceAccountSecretProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnServiceAccountSecret.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnServiceAccountSecret.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnServiceAccountSecret } from 'awscdk-resources-mongodbatlas' CfnServiceAccountSecret.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrCreatedAt | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.CreatedAt`. | | attrExpiresAt | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.ExpiresAt`. | | attrLastUsedAt | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.LastUsedAt`. | | attrMaskedSecretValue | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.MaskedSecretValue`. | | attrSecret | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.Secret`. | | attrSecretId | string | Attribute `MongoDB::Atlas::ServiceAccountSecret.SecretId`. | | props | CfnServiceAccountSecretProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrCreatedAt`^Required ```typescript public readonly attrCreatedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.CreatedAt`. --- ##### `attrExpiresAt`^Required ```typescript public readonly attrExpiresAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.ExpiresAt`. --- ##### `attrLastUsedAt`^Required ```typescript public readonly attrLastUsedAt: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.LastUsedAt`. --- ##### `attrMaskedSecretValue`^Required ```typescript public readonly attrMaskedSecretValue: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.MaskedSecretValue`. --- ##### `attrSecret`^Required ```typescript public readonly attrSecret: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.Secret`. --- ##### `attrSecretId`^Required ```typescript public readonly attrSecretId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::ServiceAccountSecret.SecretId`. --- ##### `props`^Required ```typescript public readonly props: CfnServiceAccountSecretProps; ``` - *Type:* CfnServiceAccountSecretProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnStreamConnection A CloudFormation `MongoDB::Atlas::StreamConnection`. #### Initializers ```typescript import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' new CfnStreamConnection(scope: Construct, id: string, props: CfnStreamConnectionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnStreamConnectionProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnStreamConnectionProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' CfnStreamConnection.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' CfnStreamConnection.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' CfnStreamConnection.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnStreamConnectionProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnStreamConnectionProps; ``` - *Type:* CfnStreamConnectionProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnStreamInstance A CloudFormation `MongoDB::Atlas::StreamInstance`. #### Initializers ```typescript import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' new CfnStreamInstance(scope: Construct, id: string, props: CfnStreamInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnStreamInstanceProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnStreamInstanceProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' CfnStreamInstance.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' CfnStreamInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' CfnStreamInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrHostnames | string[] | Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. | | attrId | string | Attribute `MongoDB::Atlas::StreamInstance.Id`. | | props | CfnStreamInstanceProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrHostnames`^Required ```typescript public readonly attrHostnames: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamInstance.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnStreamInstanceProps; ``` - *Type:* CfnStreamInstanceProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnStreamPrivatelinkEndpoint A CloudFormation `MongoDB::Atlas::StreamPrivatelinkEndpoint`. #### Initializers ```typescript import { CfnStreamPrivatelinkEndpoint } from 'awscdk-resources-mongodbatlas' new CfnStreamPrivatelinkEndpoint(scope: Construct, id: string, props: CfnStreamPrivatelinkEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnStreamPrivatelinkEndpointProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnStreamPrivatelinkEndpointProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnStreamPrivatelinkEndpoint } from 'awscdk-resources-mongodbatlas' CfnStreamPrivatelinkEndpoint.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnStreamPrivatelinkEndpoint } from 'awscdk-resources-mongodbatlas' CfnStreamPrivatelinkEndpoint.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnStreamPrivatelinkEndpoint } from 'awscdk-resources-mongodbatlas' CfnStreamPrivatelinkEndpoint.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrErrorMessage | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.ErrorMessage`. | | attrId | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.Id`. | | attrInterfaceEndpointId | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.InterfaceEndpointId`. | | attrInterfaceEndpointName | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.InterfaceEndpointName`. | | attrProviderAccountId | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.ProviderAccountId`. | | attrState | string | Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.State`. | | props | CfnStreamPrivatelinkEndpointProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrErrorMessage`^Required ```typescript public readonly attrErrorMessage: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.ErrorMessage`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.Id`. --- ##### `attrInterfaceEndpointId`^Required ```typescript public readonly attrInterfaceEndpointId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.InterfaceEndpointId`. --- ##### `attrInterfaceEndpointName`^Required ```typescript public readonly attrInterfaceEndpointName: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.InterfaceEndpointName`. --- ##### `attrProviderAccountId`^Required ```typescript public readonly attrProviderAccountId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.ProviderAccountId`. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamPrivatelinkEndpoint.State`. --- ##### `props`^Required ```typescript public readonly props: CfnStreamPrivatelinkEndpointProps; ``` - *Type:* CfnStreamPrivatelinkEndpointProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnStreamProcessor A CloudFormation `MongoDB::Atlas::StreamProcessor`. #### Initializers ```typescript import { CfnStreamProcessor } from 'awscdk-resources-mongodbatlas' new CfnStreamProcessor(scope: Construct, id: string, props: CfnStreamProcessorProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnStreamProcessorProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnStreamProcessorProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnStreamProcessor } from 'awscdk-resources-mongodbatlas' CfnStreamProcessor.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnStreamProcessor } from 'awscdk-resources-mongodbatlas' CfnStreamProcessor.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnStreamProcessor } from 'awscdk-resources-mongodbatlas' CfnStreamProcessor.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::StreamProcessor.Id`. | | attrState | string | Attribute `MongoDB::Atlas::StreamProcessor.State`. | | attrStats | string | Attribute `MongoDB::Atlas::StreamProcessor.Stats`. | | props | CfnStreamProcessorProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamProcessor.Id`. --- ##### `attrState`^Required ```typescript public readonly attrState: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamProcessor.State`. --- ##### `attrStats`^Required ```typescript public readonly attrStats: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamProcessor.Stats`. --- ##### `props`^Required ```typescript public readonly props: CfnStreamProcessorProps; ``` - *Type:* CfnStreamProcessorProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnStreamWorkspace A CloudFormation `MongoDB::Atlas::StreamWorkspace`. #### Initializers ```typescript import { CfnStreamWorkspace } from 'awscdk-resources-mongodbatlas' new CfnStreamWorkspace(scope: Construct, id: string, props: CfnStreamWorkspaceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnStreamWorkspaceProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnStreamWorkspaceProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnStreamWorkspace } from 'awscdk-resources-mongodbatlas' CfnStreamWorkspace.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnStreamWorkspace } from 'awscdk-resources-mongodbatlas' CfnStreamWorkspace.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnStreamWorkspace } from 'awscdk-resources-mongodbatlas' CfnStreamWorkspace.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrHostnames | string[] | Attribute `MongoDB::Atlas::StreamWorkspace.Hostnames`. | | attrId | string | Attribute `MongoDB::Atlas::StreamWorkspace.Id`. | | props | CfnStreamWorkspaceProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrHostnames`^Required ```typescript public readonly attrHostnames: string[]; ``` - *Type:* string[] Attribute `MongoDB::Atlas::StreamWorkspace.Hostnames`. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::StreamWorkspace.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnStreamWorkspaceProps; ``` - *Type:* CfnStreamWorkspaceProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnTeams A CloudFormation `MongoDB::Atlas::Teams`. #### Initializers ```typescript import { CfnTeams } from 'awscdk-resources-mongodbatlas' new CfnTeams(scope: Construct, id: string, props: CfnTeamsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnTeamsProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnTeamsProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnTeams } from 'awscdk-resources-mongodbatlas' CfnTeams.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnTeams } from 'awscdk-resources-mongodbatlas' CfnTeams.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnTeams } from 'awscdk-resources-mongodbatlas' CfnTeams.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrTeamId | string | Attribute `MongoDB::Atlas::Teams.TeamId`. | | props | CfnTeamsProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrTeamId`^Required ```typescript public readonly attrTeamId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Teams.TeamId`. --- ##### `props`^Required ```typescript public readonly props: CfnTeamsProps; ``` - *Type:* CfnTeamsProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnThirdPartyIntegration A CloudFormation `MongoDB::Atlas::ThirdPartyIntegration`. #### Initializers ```typescript import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' new CfnThirdPartyIntegration(scope: Construct, id: string, props: CfnThirdPartyIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnThirdPartyIntegrationProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnThirdPartyIntegrationProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' CfnThirdPartyIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' CfnThirdPartyIntegration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' CfnThirdPartyIntegration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | props | CfnThirdPartyIntegrationProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `props`^Required ```typescript public readonly props: CfnThirdPartyIntegrationProps; ``` - *Type:* CfnThirdPartyIntegrationProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnTrigger A CloudFormation `MongoDB::Atlas::Trigger`. #### Initializers ```typescript import { CfnTrigger } from 'awscdk-resources-mongodbatlas' new CfnTrigger(scope: Construct, id: string, props: CfnTriggerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnTriggerProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnTriggerProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnTrigger } from 'awscdk-resources-mongodbatlas' CfnTrigger.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnTrigger } from 'awscdk-resources-mongodbatlas' CfnTrigger.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnTrigger } from 'awscdk-resources-mongodbatlas' CfnTrigger.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrId | string | Attribute `MongoDB::Atlas::Trigger.Id`. | | props | CfnTriggerProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string Attribute `MongoDB::Atlas::Trigger.Id`. --- ##### `props`^Required ```typescript public readonly props: CfnTriggerProps; ``` - *Type:* CfnTriggerProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnX509AuthenticationDatabaseUser A CloudFormation `MongoDB::Atlas::X509AuthenticationDatabaseUser`. #### Initializers ```typescript import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' new CfnX509AuthenticationDatabaseUser(scope: Construct, id: string, props: CfnX509AuthenticationDatabaseUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | - scope in which this resource is defined. | | id | string | - scoped id of the resource. | | props | CfnX509AuthenticationDatabaseUserProps | - resource properties. | --- ##### `scope`^Required - *Type:* constructs.Construct scope in which this resource is defined. --- ##### `id`^Required - *Type:* string scoped id of the resource. --- ##### `props`^Required - *Type:* CfnX509AuthenticationDatabaseUserProps resource properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | --- ##### ~~`isConstruct`~~ ```typescript import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnX509AuthenticationDatabaseUser.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isCfnElement` ```typescript import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnX509AuthenticationDatabaseUser.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' CfnX509AuthenticationDatabaseUser.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | attrMonthsUntilExpiration | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. | | attrTotalCount | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. | | props | CfnX509AuthenticationDatabaseUserProps | Resource props. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `attrMonthsUntilExpiration`^Required ```typescript public readonly attrMonthsUntilExpiration: number; ``` - *Type:* number Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. --- ##### `attrTotalCount`^Required ```typescript public readonly attrTotalCount: number; ``` - *Type:* number Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. --- ##### `props`^Required ```typescript public readonly props: CfnX509AuthenticationDatabaseUserProps; ``` - *Type:* CfnX509AuthenticationDatabaseUserProps Resource props. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### DatadogIntegration #### Initializers ```typescript import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' new DatadogIntegration(scope: Construct, id: string, props: DatadogIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DatadogIntegrationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DatadogIntegrationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' DatadogIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnThirdPartyIntegration | CfnThirdPartyIntegration | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnThirdPartyIntegration`^Required ```typescript public readonly cfnThirdPartyIntegration: CfnThirdPartyIntegration; ``` - *Type:* CfnThirdPartyIntegration --- ### MicrosoftTeamsIntegration #### Initializers ```typescript import { MicrosoftTeamsIntegration } from 'awscdk-resources-mongodbatlas' new MicrosoftTeamsIntegration(scope: Construct, id: string, props: MicrosoftTeamsIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicrosoftTeamsIntegrationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MicrosoftTeamsIntegrationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { MicrosoftTeamsIntegration } from 'awscdk-resources-mongodbatlas' MicrosoftTeamsIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnThirdPartyIntegration | CfnThirdPartyIntegration | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnThirdPartyIntegration`^Required ```typescript public readonly cfnThirdPartyIntegration: CfnThirdPartyIntegration; ``` - *Type:* CfnThirdPartyIntegration --- ### MongoAtlasBootstrap Generate the CFN extension execution role. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) #### Initializers ```typescript import { MongoAtlasBootstrap } from 'awscdk-resources-mongodbatlas' new MongoAtlasBootstrap(scope: Construct, id: string, props?: MongoAtlasBootstrapProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MongoAtlasBootstrapProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MongoAtlasBootstrapProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { MongoAtlasBootstrap } from 'awscdk-resources-mongodbatlas' MongoAtlasBootstrap.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | role | aws-cdk-lib.aws_iam.IRole | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `role`^Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ### MongoSecretProfile #### Initializers ```typescript import { MongoSecretProfile } from 'awscdk-resources-mongodbatlas' new MongoSecretProfile(scope: Construct, id: string, profileName: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | profileName | string | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `profileName`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { MongoSecretProfile } from 'awscdk-resources-mongodbatlas' MongoSecretProfile.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### PagerDutyIntegration #### Initializers ```typescript import { PagerDutyIntegration } from 'awscdk-resources-mongodbatlas' new PagerDutyIntegration(scope: Construct, id: string, props: PagerDutyIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PagerDutyIntegrationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PagerDutyIntegrationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { PagerDutyIntegration } from 'awscdk-resources-mongodbatlas' PagerDutyIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnThirdPartyIntegration | CfnThirdPartyIntegration | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnThirdPartyIntegration`^Required ```typescript public readonly cfnThirdPartyIntegration: CfnThirdPartyIntegration; ``` - *Type:* CfnThirdPartyIntegration --- ## Structs ### AccessListDefinition #### Initializer ```typescript import { AccessListDefinition } from 'awscdk-resources-mongodbatlas' const accessListDefinition: AccessListDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsSecurityGroup | string | Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. | | cidrBlock | string | Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. | | comment | string | Remark that explains the purpose or scope of this IP access list entry. | | deleteAfterDate | string | Date and time after which MongoDB Cloud deletes the temporary access list entry. | | ipAddress | string | IP address that you want to add to the project's IP access list. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | --- ##### `awsSecurityGroup`^Optional ```typescript public readonly awsSecurityGroup: string; ``` - *Type:* string Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set cidrBlock or ipAddress. --- ##### `cidrBlock`^Optional ```typescript public readonly cidrBlock: string; ``` - *Type:* string Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or ipAddress --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string Remark that explains the purpose or scope of this IP access list entry. --- ##### `deleteAfterDate`^Optional ```typescript public readonly deleteAfterDate: string; ``` - *Type:* string Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry. --- ##### `ipAddress`^Optional ```typescript public readonly ipAddress: string; ``` - *Type:* string IP address that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or cidrBlock. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ### Action #### Initializer ```typescript import { Action } from 'awscdk-resources-mongodbatlas' const action: Action = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | Human-readable label that identifies the privilege action. | | resources | Resource[] | List of resources on which you grant the action. | --- ##### `action`^Optional ```typescript public readonly action: string; ``` - *Type:* string Human-readable label that identifies the privilege action. --- ##### `resources`^Optional ```typescript public readonly resources: Resource[]; ``` - *Type:* Resource[] List of resources on which you grant the action. --- ### AdvancedAutoScaling AWS Automatic Cluster Scaling. #### Initializer ```typescript import { AdvancedAutoScaling } from 'awscdk-resources-mongodbatlas' const advancedAutoScaling: AdvancedAutoScaling = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | compute | Compute | *No description.* | | diskGb | DiskGb | *No description.* | --- ##### `compute`^Optional ```typescript public readonly compute: Compute; ``` - *Type:* Compute --- ##### `diskGb`^Optional ```typescript public readonly diskGb: DiskGb; ``` - *Type:* DiskGb --- ### AdvancedRegionConfig Hardware specifications for nodes set for a given region. Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each regionConfigs object must have either an analyticsSpecs object, electableSpecs object, or readOnlySpecs object. Tenant clusters only require electableSpecs. Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec. Every hardware specification must use the same instanceSize. Example: If you set "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30", set "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M30"if you have electable nodes and"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : "M30" if you have read-only nodes.", #### Initializer ```typescript import { AdvancedRegionConfig } from 'awscdk-resources-mongodbatlas' const advancedRegionConfig: AdvancedRegionConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | analyticsAutoScaling | AdvancedAutoScaling | *No description.* | | analyticsSpecs | Specs | *No description.* | | autoScaling | AdvancedAutoScaling | *No description.* | | backingProviderName | string | *No description.* | | electableSpecs | Specs | *No description.* | | priority | number | *No description.* | | providerName | AdvancedRegionConfigProviderName | *No description.* | | readOnlySpecs | Specs | *No description.* | | regionName | string | *No description.* | --- ##### `analyticsAutoScaling`^Optional ```typescript public readonly analyticsAutoScaling: AdvancedAutoScaling; ``` - *Type:* AdvancedAutoScaling --- ##### `analyticsSpecs`^Optional ```typescript public readonly analyticsSpecs: Specs; ``` - *Type:* Specs --- ##### `autoScaling`^Optional ```typescript public readonly autoScaling: AdvancedAutoScaling; ``` - *Type:* AdvancedAutoScaling --- ##### `backingProviderName`^Optional ```typescript public readonly backingProviderName: string; ``` - *Type:* string --- ##### `electableSpecs`^Optional ```typescript public readonly electableSpecs: Specs; ``` - *Type:* Specs --- ##### `priority`^Optional ```typescript public readonly priority: number; ``` - *Type:* number --- ##### `providerName`^Optional ```typescript public readonly providerName: AdvancedRegionConfigProviderName; ``` - *Type:* AdvancedRegionConfigProviderName --- ##### `readOnlySpecs`^Optional ```typescript public readonly readOnlySpecs: Specs; ``` - *Type:* Specs --- ##### `regionName`^Optional ```typescript public readonly regionName: string; ``` - *Type:* string --- ### AdvancedReplicationSpec List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy. #### Initializer ```typescript import { AdvancedReplicationSpec } from 'awscdk-resources-mongodbatlas' const advancedReplicationSpec: AdvancedReplicationSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | advancedRegionConfigs | AdvancedRegionConfig[] | Hardware specifications for nodes set for a given region. | | id | string | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. | | numShards | number | Positive integer that specifies the number of shards to deploy in each specified zone. | | zoneName | string | Human-readable label that identifies the zone in a Global Cluster. | --- ##### `advancedRegionConfigs`^Optional ```typescript public readonly advancedRegionConfigs: AdvancedRegionConfig[]; ``` - *Type:* AdvancedRegionConfig[] Hardware specifications for nodes set for a given region. Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each regionConfigs object must have either an analyticsSpecs object, electableSpecs object, or readOnlySpecs object. Tenant clusters only require electableSpecs. Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec. Every hardware specification must use the same instanceSize. Example: If you set "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30", set "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M30"if you have electable nodes and"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : "M30" if you have read-only nodes.", --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request. --- ##### `numShards`^Optional ```typescript public readonly numShards: number; ``` - *Type:* number Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to 1 and "clusterType" : "SHARDED", MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations. --- ##### `zoneName`^Optional ```typescript public readonly zoneName: string; ``` - *Type:* string Human-readable label that identifies the zone in a Global Cluster. Provide this value only if "clusterType" : "GEOSHARDED". --- ### ApiAtlasDiskBackupCopySettingView #### Initializer ```typescript import { ApiAtlasDiskBackupCopySettingView } from 'awscdk-resources-mongodbatlas' const apiAtlasDiskBackupCopySettingView: ApiAtlasDiskBackupCopySettingView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | string | A label that identifies the cloud provider that stores the snapshot copy. | | frequencies | string[] | List that describes which types of snapshots to copy. | | regionName | string | Target region to copy snapshots belonging to replicationSpecId to. | | replicationSpecId | string | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. | | shouldCopyOplogs | boolean | Flag that indicates whether to copy the oplogs to the target region. | --- ##### `cloudProvider`^Optional ```typescript public readonly cloudProvider: string; ``` - *Type:* string A label that identifies the cloud provider that stores the snapshot copy. --- ##### `frequencies`^Optional ```typescript public readonly frequencies: string[]; ``` - *Type:* string[] List that describes which types of snapshots to copy. --- ##### `regionName`^Optional ```typescript public readonly regionName: string; ``` - *Type:* string Target region to copy snapshots belonging to replicationSpecId to. --- ##### `replicationSpecId`^Optional ```typescript public readonly replicationSpecId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. --- ##### `shouldCopyOplogs`^Optional ```typescript public readonly shouldCopyOplogs: boolean; ``` - *Type:* boolean Flag that indicates whether to copy the oplogs to the target region. --- ### ApiAtlasDiskBackupShardedClusterSnapshotMemberView #### Initializer ```typescript import { ApiAtlasDiskBackupShardedClusterSnapshotMemberView } from 'awscdk-resources-mongodbatlas' const apiAtlasDiskBackupShardedClusterSnapshotMemberView: ApiAtlasDiskBackupShardedClusterSnapshotMemberView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider | Human-readable label that identifies the cloud provider that stores this snapshot. | | id | string | Unique 24-hexadecimal digit string that identifies the snapshot. | | replicaSetName | string | Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot. | --- ##### `cloudProvider`^Optional ```typescript public readonly cloudProvider: ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `"type": "replicaSet".` --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the snapshot. --- ##### `replicaSetName`^Optional ```typescript public readonly replicaSetName: string; ``` - *Type:* string Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot. --- ### ApiAtlasDiskBackupShardedClusterSnapshotView #### Initializer ```typescript import { ApiAtlasDiskBackupShardedClusterSnapshotView } from 'awscdk-resources-mongodbatlas' const apiAtlasDiskBackupShardedClusterSnapshotView: ApiAtlasDiskBackupShardedClusterSnapshotView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | createdAt | string | Date and time when MongoDB Cloud took the snapshot. | | description | string | Human-readable phrase or sentence that explains the purpose of the snapshot. | | expiresAt | string | Date and time when MongoDB Cloud deletes the snapshot. | | frequencyType | ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType | Human-readable label that identifies how often this snapshot triggers. | | id | string | Unique 24-hexadecimal digit string that identifies the snapshot. | | masterKeyUuid | string | Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. | | members | ApiAtlasDiskBackupShardedClusterSnapshotMemberView[] | List that includes the snapshots and the cloud provider that stores the snapshots. | | mongodVersion | string | 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. | | snapshotType | ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType | Human-readable label that identifies when this snapshot triggers. | | status | ApiAtlasDiskBackupShardedClusterSnapshotViewStatus | Human-readable label that indicates the stage of the backup process for this snapshot. | | storageSizeBytes | string | Number of bytes taken to store the backup snapshot. | | type | ApiAtlasDiskBackupShardedClusterSnapshotViewType | Human-readable label that categorizes the cluster as a replica set or sharded cluster. | --- ##### `createdAt`^Optional ```typescript public readonly createdAt: string; ``` - *Type:* string Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`. --- ##### `expiresAt`^Optional ```typescript public readonly expiresAt: string; ``` - *Type:* string Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType Human-readable label that identifies how often this snapshot triggers. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the snapshot. --- ##### `masterKeyUuid`^Optional ```typescript public readonly masterKeyUuid: string; ``` - *Type:* string 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`^Optional ```typescript public readonly members: ApiAtlasDiskBackupShardedClusterSnapshotMemberView[]; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotMemberView[] List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `"type" : "SHARDED_CLUSTER"`. --- ##### `mongodVersion`^Optional ```typescript public readonly mongodVersion: string; ``` - *Type:* string Version of the MongoDB host that this snapshot backs up. --- ##### `policyItems`^Optional ```typescript public readonly policyItems: string[]; ``` - *Type:* string[] List that contains unique identifiers for the policy items. --- ##### `snapshotIds`^Optional ```typescript public readonly snapshotIds: string[]; ``` - *Type:* 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`^Optional ```typescript public readonly snapshotType: ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType Human-readable label that identifies when this snapshot triggers. --- ##### `status`^Optional ```typescript public readonly status: ApiAtlasDiskBackupShardedClusterSnapshotViewStatus; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotViewStatus Human-readable label that indicates the stage of the backup process for this snapshot. --- ##### `storageSizeBytes`^Optional ```typescript public readonly storageSizeBytes: string; ``` - *Type:* string Number of bytes taken to store the backup snapshot. --- ##### `type`^Optional ```typescript public readonly type: ApiAtlasDiskBackupShardedClusterSnapshotViewType; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotViewType Human-readable label that categorizes the cluster as a replica set or sharded cluster. --- ### ApiAtlasFtsAnalyzersTokenizer Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing. #### Initializer ```typescript import { ApiAtlasFtsAnalyzersTokenizer } from 'awscdk-resources-mongodbatlas' const apiAtlasFtsAnalyzersTokenizer: ApiAtlasFtsAnalyzersTokenizer = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | group | number | Index of the character group within the matching expression to extract into tokens. | | maxGram | number | Characters to include in the longest token that Atlas Search creates. | | maxTokenLength | number | Maximum number of characters in a single token. | | minGram | number | Characters to include in the shortest token that Atlas Search creates. | | pattern | string | Regular expression to match against. | | type | string | Human-readable label that identifies this tokenizer type. | --- ##### `group`^Optional ```typescript public readonly group: number; ``` - *Type:* number Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups. --- ##### `maxGram`^Optional ```typescript public readonly maxGram: number; ``` - *Type:* number Characters to include in the longest token that Atlas Search creates. --- ##### `maxTokenLength`^Optional ```typescript public readonly maxTokenLength: number; ``` - *Type:* number Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. --- ##### `minGram`^Optional ```typescript public readonly minGram: number; ``` - *Type:* number Characters to include in the shortest token that Atlas Search creates. --- ##### `pattern`^Optional ```typescript public readonly pattern: string; ``` - *Type:* string Regular expression to match against. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Human-readable label that identifies this tokenizer type. --- ### ApiAtlasFtsAnalyzersViewManual #### Initializer ```typescript import { ApiAtlasFtsAnalyzersViewManual } from 'awscdk-resources-mongodbatlas' const apiAtlasFtsAnalyzersViewManual: ApiAtlasFtsAnalyzersViewManual = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | charFilters | string[] | Filters that examine text one character at a time and perform filtering operations. | | name | string | Human-readable name that identifies the custom analyzer. | | tokenFilters | string[] | Filter that performs operations such as:. | | tokenizer | ApiAtlasFtsAnalyzersTokenizer | Tokenizer that you want to use to create tokens. | --- ##### `charFilters`^Optional ```typescript public readonly charFilters: string[]; ``` - *Type:* string[] Filters that examine text one character at a time and perform filtering operations. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings: - `lucene.` - `builtin.` - `mongodb.` --- ##### `tokenFilters`^Optional ```typescript public readonly tokenFilters: string[]; ``` - *Type:* string[] Filter that performs operations such as:. Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk". - Redaction, the removal of sensitive information from public documents. --- ##### `tokenizer`^Optional ```typescript public readonly tokenizer: ApiAtlasFtsAnalyzersTokenizer; ``` - *Type:* ApiAtlasFtsAnalyzersTokenizer Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing. --- ### ApiAtlasFtsMappingsViewManual #### Initializer ```typescript import { ApiAtlasFtsMappingsViewManual } from 'awscdk-resources-mongodbatlas' const apiAtlasFtsMappingsViewManual: ApiAtlasFtsMappingsViewManual = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dynamic | boolean | Flag that indicates whether the index uses dynamic or static mappings. | | dynamicConfig | string | Stringify json representation of dynamic mapping configuration object. | | fields | string | One or more field specifications for the Atlas Search index. | --- ##### `dynamic`^Optional ```typescript public readonly dynamic: boolean; ``` - *Type:* boolean Flag that indicates whether the index uses dynamic or static mappings. If DynamicConfig is specified, this field is ignored (DynamicConfig takes precedence). Required for search indexes if **mappings.fields** is omitted and **mappings.dynamicConfig** is not specified. --- ##### `dynamicConfig`^Optional ```typescript public readonly dynamicConfig: string; ``` - *Type:* string Stringify json representation of dynamic mapping configuration object. This allows for more complex dynamic mapping configurations beyond a simple boolean. If both Dynamic and DynamicConfig are specified, DynamicConfig takes precedence. --- ##### `fields`^Optional ```typescript public readonly fields: string; ``` - *Type:* string One or more field specifications for the Atlas Search index. Stringify json representation of field with types and properties. Required for search indexes if **mappings.dynamic** and **mappings.dynamicConfig** are omitted or if **mappings.dynamic** is set to **false**. --- ### ApiAtlasFtsSynonymMappingDefinitionView #### Initializer ```typescript import { ApiAtlasFtsSynonymMappingDefinitionView } from 'awscdk-resources-mongodbatlas' const apiAtlasFtsSynonymMappingDefinitionView: ApiAtlasFtsSynonymMappingDefinitionView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | analyzer | string | Specific pre-defined method chosen to apply to the synonyms to be searched. | | name | string | Human-readable label that identifies the synonym definition. | | source | SynonymSource | Data set that stores the mapping one or more words map to one or more synonyms of those words. | --- ##### `analyzer`^Required ```typescript public readonly analyzer: string; ``` - *Type:* string Specific pre-defined method chosen to apply to the synonyms to be searched. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition. --- ##### `source`^Required ```typescript public readonly source: SynonymSource; ``` - *Type:* SynonymSource Data set that stores the mapping one or more words map to one or more synonyms of those words. --- ### ApiAtlasNdsUserToDnMappingView #### Initializer ```typescript import { ApiAtlasNdsUserToDnMappingView } from 'awscdk-resources-mongodbatlas' const apiAtlasNdsUserToDnMappingView: ApiAtlasNdsUserToDnMappingView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ldapQuery | string | Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). | | match | string | Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. | | substitution | string | Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN). | --- ##### `ldapQuery`^Optional ```typescript public readonly ldapQuery: string; ``` - *Type:* string Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). --- ##### `match`^Optional ```typescript public readonly match: string; ``` - *Type:* string Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses. --- ##### `substitution`^Optional ```typescript public readonly substitution: string; ``` - *Type:* string Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN). --- ### ApiAtlasPolicy #### Initializer ```typescript import { ApiAtlasPolicy } from 'awscdk-resources-mongodbatlas' const apiAtlasPolicy: ApiAtlasPolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | body | string | A string that defines the permissions for the policy. | | id | string | Unique 24-hexadecimal character string that identifies the policy. | --- ##### `body`^Required ```typescript public readonly body: string; ``` - *Type:* string A string that defines the permissions for the policy. The syntax used is the Cedar Policy language. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the policy. --- ### ApiAtlasUserMetadata #### Initializer ```typescript import { ApiAtlasUserMetadata } from 'awscdk-resources-mongodbatlas' const apiAtlasUserMetadata: ApiAtlasUserMetadata = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | id | string | Unique 24-hexadecimal character string that identifies a user. | | name | string | Human-readable label that describes a user. | --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies a user. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that describes a user. --- ### ApiDeleteCopiedBackupsView #### Initializer ```typescript import { ApiDeleteCopiedBackupsView } from 'awscdk-resources-mongodbatlas' const apiDeleteCopiedBackupsView: ApiDeleteCopiedBackupsView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | string | A label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete. | | regionName | string | Target region for the deleted copy setting whose backup copies you want to delete. | | replicationSpecId | string | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. | --- ##### `cloudProvider`^Optional ```typescript public readonly cloudProvider: string; ``` - *Type:* string A label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete. --- ##### `regionName`^Optional ```typescript public readonly regionName: string; ``` - *Type:* string Target region for the deleted copy setting whose backup copies you want to delete. --- ##### `replicationSpecId`^Optional ```typescript public readonly replicationSpecId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. --- ### ApiKey #### Initializer ```typescript import { ApiKey } from 'awscdk-resources-mongodbatlas' const apiKey: ApiKey = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Purpose or explanation provided when someone created this organization API key. | | roles | string[] | List of roles to grant this API key. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Purpose or explanation provided when someone created this organization API key. 1 to 250 characters --- ##### `roles`^Optional ```typescript public readonly roles: string[]; ``` - *Type:* string[] List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization. --- ### ApiPolicyItemView #### Initializer ```typescript import { ApiPolicyItemView } from 'awscdk-resources-mongodbatlas' const apiPolicyItemView: ApiPolicyItemView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | frequencyInterval | number | Desired frequency of the new backup policy item specified by frequencyType. | | frequencyType | string | Frequency associated with the backup policy item. | | id | string | Unique identifier of the backup policy item. | | retentionUnit | string | Metric of duration of the backup policy item: days, weeks, months or years. | | retentionValue | number | Duration for which the backup is kept. | --- ##### `frequencyInterval`^Optional ```typescript public readonly frequencyInterval: number; ``` - *Type:* number Desired frequency of the new backup policy item specified by frequencyType. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: string; ``` - *Type:* string Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly, monthly or yearly. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the backup policy item. --- ##### `retentionUnit`^Optional ```typescript public readonly retentionUnit: string; ``` - *Type:* string Metric of duration of the backup policy item: days, weeks, months or years. --- ##### `retentionValue`^Optional ```typescript public readonly retentionValue: number; ``` - *Type:* number Duration for which the backup is kept. Associated with retentionUnit. --- ### ApiPolicyView #### Initializer ```typescript import { ApiPolicyView } from 'awscdk-resources-mongodbatlas' const apiPolicyView: ApiPolicyView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | id | string | Unique 24-hexadecimal digit string that identifies this backup policy. | | policyItems | ApiPolicyItemView[] | *No description.* | --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies this backup policy. The policy id can be retrieved by running: atlas backups schedule describe "${clusterName}" --projectId "${projectId}" | jq -r '.policies[0].id' --- ##### `policyItems`^Optional ```typescript public readonly policyItems: ApiPolicyItemView[]; ``` - *Type:* ApiPolicyItemView[] --- ### ApiSearchDeploymentSpec #### Initializer ```typescript import { ApiSearchDeploymentSpec } from 'awscdk-resources-mongodbatlas' const apiSearchDeploymentSpec: ApiSearchDeploymentSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceSize | string | Hardware specification for the search node instance sizes. | | nodeCount | number | Number of search nodes in the cluster. | --- ##### `instanceSize`^Required ```typescript public readonly instanceSize: string; ``` - *Type:* string Hardware specification for the search node instance sizes. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Atlas-Search/operation/createAtlasSearchDeployment) describes the valid values. More details can also be found in the [Search Node Documentation](https://www.mongodb.com/docs/atlas/cluster-config/multi-cloud-distribution/#search-tier). --- ##### `nodeCount`^Required ```typescript public readonly nodeCount: number; ``` - *Type:* number Number of search nodes in the cluster. --- ### AtlasBasicPrivateEndpointProps #### Initializer ```typescript import { AtlasBasicPrivateEndpointProps } from 'awscdk-resources-mongodbatlas' const atlasBasicPrivateEndpointProps: AtlasBasicPrivateEndpointProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | atlasBasicProps | AtlasBasicProps | *No description.* | | privateEndpointProps | PrivateEndpointProps | *No description.* | | profile | string | *No description.* | | region | string | *No description.* | --- ##### `atlasBasicProps`^Required ```typescript public readonly atlasBasicProps: AtlasBasicProps; ``` - *Type:* AtlasBasicProps --- ##### `privateEndpointProps`^Required ```typescript public readonly privateEndpointProps: PrivateEndpointProps; ``` - *Type:* PrivateEndpointProps --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* us-east-1 --- ### AtlasBasicProps #### Initializer ```typescript import { AtlasBasicProps } from 'awscdk-resources-mongodbatlas' const atlasBasicProps: AtlasBasicProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterProps | ClusterProps | *No description.* | | ipAccessListProps | IpAccessListProps | *No description.* | | projectProps | ProjectProps | *No description.* | | dbUserProps | DatabaseUserProps | *No description.* | | profile | string | *No description.* | --- ##### `clusterProps`^Required ```typescript public readonly clusterProps: ClusterProps; ``` - *Type:* ClusterProps --- ##### `ipAccessListProps`^Required ```typescript public readonly ipAccessListProps: IpAccessListProps; ``` - *Type:* IpAccessListProps --- ##### `projectProps`^Required ```typescript public readonly projectProps: ProjectProps; ``` - *Type:* ProjectProps --- ##### `dbUserProps`^Optional ```typescript public readonly dbUserProps: DatabaseUserProps; ``` - *Type:* DatabaseUserProps --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string --- ### AtlasEncryptionAtRestExpressProps #### Initializer ```typescript import { AtlasEncryptionAtRestExpressProps } from 'awscdk-resources-mongodbatlas' const atlasEncryptionAtRestExpressProps: AtlasEncryptionAtRestExpressProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | encryptionAtRest | EncryptionAtRestProps | *No description.* | | projectId | string | *No description.* | | accessList | IpAccessListProps | *No description.* | | cluster | ClusterProps | *No description.* | | databaseUser | DatabaseUserProps | *No description.* | | profile | string | *No description.* | --- ##### `encryptionAtRest`^Required ```typescript public readonly encryptionAtRest: EncryptionAtRestProps; ``` - *Type:* EncryptionAtRestProps --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string --- ##### `accessList`^Optional ```typescript public readonly accessList: IpAccessListProps; ``` - *Type:* IpAccessListProps --- ##### `cluster`^Optional ```typescript public readonly cluster: ClusterProps; ``` - *Type:* ClusterProps --- ##### `databaseUser`^Optional ```typescript public readonly databaseUser: DatabaseUserProps; ``` - *Type:* DatabaseUserProps --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string --- ### AtlasEncryptionAtRestProps #### Initializer ```typescript import { AtlasEncryptionAtRestProps } from 'awscdk-resources-mongodbatlas' const atlasEncryptionAtRestProps: AtlasEncryptionAtRestProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customerMasterKeyId | string | The AWS customer master key used to encrypt and decrypt the MongoDB master keys. | | projectId | string | Unique identifier of the Atlas project to which the user belongs. | | roleId | string | ID of an AWS IAM role authorized to manage an AWS customer master key. | | enabled | boolean | Specifies whether Encryption at Rest is enabled for an Atlas project. | | profile | string | The profile is defined in AWS Secret manager. | | region | string | The AWS region in which the AWS customer master key exists. | --- ##### `customerMasterKeyId`^Required ```typescript public readonly customerMasterKeyId: string; ``` - *Type:* string The AWS customer master key used to encrypt and decrypt the MongoDB master keys. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique identifier of the Atlas project to which the user belongs. --- ##### `roleId`^Required ```typescript public readonly roleId: string; ``` - *Type:* string ID of an AWS IAM role authorized to manage an AWS customer master key. --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* 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. Default Value: true --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string The AWS region in which the AWS customer master key exists. Default Value: US_EAST_1 --- ### AtlasRole #### Initializer ```typescript import { AtlasRole } from 'awscdk-resources-mongodbatlas' const atlasRole: AtlasRole = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. | | projectId | string | Unique 24-hexadecimal digit string that identifies the project to which this role belongs. | | roleName | AtlasRoleRoleName | Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. | --- ##### `orgId`^Optional ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request. --- ##### `roleName`^Optional ```typescript public readonly roleName: AtlasRoleRoleName; ``` - *Type:* AtlasRoleRoleName Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. Organization Roles * ORG_OWNER * ORG_MEMBER * ORG_GROUP_CREATOR * ORG_BILLING_ADMIN * ORG_READ_ONLY Project Roles * GROUP_CLUSTER_MANAGER * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_ONLY * GROUP_DATA_ACCESS_READ_WRITE * GROUP_OWNER * GROUP_READ_ONLY --- ### AtlasUser #### Initializer ```typescript import { AtlasUser } from 'awscdk-resources-mongodbatlas' const atlasUser: AtlasUser = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | country | string | Two alphabet characters that identifies MongoDB Cloud user's geographic location. | | emailAddress | string | Email address that belongs to the MongoDB Cloud user. | | firstName | string | First or given name that belongs to the MongoDB Cloud user. | | id | string | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. | | lastName | string | Last name, family name, or surname that belongs to the MongoDB Cloud user. | | links | Link[] | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. | | mobileNumber | string | Mobile phone number that belongs to the MongoDB Cloud user. | | password | string | Password applied with the username to log in to MongoDB Cloud. | | roles | AtlasRole[] | List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. | | teamIds | string[] | List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs. | | username | string | Email address that represents the username of the MongoDB Cloud user. | --- ##### `country`^Optional ```typescript public readonly country: string; ``` - *Type:* string Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format. --- ##### `emailAddress`^Optional ```typescript public readonly emailAddress: string; ``` - *Type:* string Email address that belongs to the MongoDB Cloud user. --- ##### `firstName`^Optional ```typescript public readonly firstName: string; ``` - *Type:* string First or given name that belongs to the MongoDB Cloud user. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. --- ##### `lastName`^Optional ```typescript public readonly lastName: string; ``` - *Type:* string Last name, family name, or surname that belongs to the MongoDB Cloud user. --- ##### `links`^Optional ```typescript public readonly links: Link[]; ``` - *Type:* Link[] List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. --- ##### `mobileNumber`^Optional ```typescript public readonly mobileNumber: string; ``` - *Type:* string Mobile phone number that belongs to the MongoDB Cloud user. --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console. --- ##### `roles`^Optional ```typescript public readonly roles: AtlasRole[]; ``` - *Type:* AtlasRole[] List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both. --- ##### `teamIds`^Optional ```typescript public readonly teamIds: string[]; ``` - *Type:* string[] List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string Email address that represents the username of the MongoDB Cloud user. --- ### AuthConfig #### Initializer ```typescript import { AuthConfig } from 'awscdk-resources-mongodbatlas' const authConfig: AuthConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operationType | AuthConfigOperationType | The type of authentication event that the trigger listens for. | | providers | AuthConfigProviders[] | The type(s) of authentication provider that the trigger listens to. | --- ##### `operationType`^Required ```typescript public readonly operationType: AuthConfigOperationType; ``` - *Type:* AuthConfigOperationType The type of authentication event that the trigger listens for. --- ##### `providers`^Required ```typescript public readonly providers: AuthConfigProviders[]; ``` - *Type:* AuthConfigProviders[] The type(s) of authentication provider that the trigger listens to. --- ### Aws AWS Lambda connection configuration. #### Initializer ```typescript import { Aws } from 'awscdk-resources-mongodbatlas' const aws: Aws = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleArn | string | Amazon Resource Name (ARN) of the IAM role for AWS Lambda connection. | | testBucket | string | The name of an S3 bucket used to check authorization of the passed-in IAM role ARN. | --- ##### `roleArn`^Required ```typescript public readonly roleArn: string; ``` - *Type:* string Amazon Resource Name (ARN) of the IAM role for AWS Lambda connection. --- ##### `testBucket`^Optional ```typescript public readonly testBucket: string; ``` - *Type:* string The name of an S3 bucket used to check authorization of the passed-in IAM role ARN. --- ### AwsKmsConfig Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project. #### Initializer ```typescript import { AwsKmsConfig } from 'awscdk-resources-mongodbatlas' const awsKmsConfig: AwsKmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customerMasterKeyId | string | Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys. | | enabled | boolean | Specifies whether Encryption at Rest is enabled for an Atlas project. | | region | string | Physical location where MongoDB Atlas deploys your AWS-hosted MongoDB cluster nodes. | | requirePrivateNetworking | boolean | Enable connection to your Amazon Web Services (AWS) Key Management Service (KMS) over private networking. | | roleId | string | Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. | | valid | boolean | Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data. | --- ##### `customerMasterKeyId`^Optional ```typescript public readonly customerMasterKeyId: string; ``` - *Type:* string Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys. --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* 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`^Optional ```typescript public readonly region: string; ``` - *Type:* string Physical location where MongoDB Atlas deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. --- ##### `requirePrivateNetworking`^Optional ```typescript public readonly requirePrivateNetworking: boolean; ``` - *Type:* boolean Enable connection to your Amazon Web Services (AWS) Key Management Service (KMS) over private networking. --- ##### `roleId`^Optional ```typescript public readonly roleId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key. --- ##### `valid`^Optional ```typescript public readonly valid: boolean; ``` - *Type:* boolean Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data. --- ### BackupSettings Flex backup configuration. #### Initializer ```typescript import { BackupSettings } from 'awscdk-resources-mongodbatlas' const backupSettings: BackupSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Flag that indicates whether backups are performed for this flex cluster. | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups. --- ### CfnAccessListApiKeyProps Creates the access list entries for the specified organization API key. #### Initializer ```typescript import { CfnAccessListApiKeyProps } from 'awscdk-resources-mongodbatlas' const cfnAccessListApiKeyProps: CfnAccessListApiKeyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiUserId | string | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | cidrBlock | string | Range of network addresses that you want to add to the access list for the API key. | | ipAddress | string | Network address that you want to add to the access list for the API key. | | profile | string | Network address that issued the most recent request to the API. | | totalCount | number | Number of documents returned in this response. | --- ##### `apiUserId`^Required ```typescript public readonly apiUserId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. --- ##### `cidrBlock`^Optional ```typescript public readonly cidrBlock: string; ``` - *Type:* string Range of network addresses that you want to add to the access list for the API key. --- ##### `ipAddress`^Optional ```typescript public readonly ipAddress: string; ``` - *Type:* string Network address that you want to add to the access list for the API key. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Network address that issued the most recent request to the API. --- ##### `totalCount`^Optional ```typescript public readonly totalCount: number; ``` - *Type:* number Number of documents returned in this response. --- ### CfnAlertConfigurationProps Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link. #### Initializer ```typescript import { CfnAlertConfigurationProps } from 'awscdk-resources-mongodbatlas' const cfnAlertConfigurationProps: CfnAlertConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | eventTypeName | string | Event type that triggers an alert. | | matchers | Matcher[] | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. | | metricThreshold | MetricThresholdView | Threshold for the metric that, when exceeded, triggers an alert. | | notifications | NotificationView[] | List that contains the targets that MongoDB Cloud sends notifications. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | severityOverride | string | Degree of seriousness given to this alert. | | threshold | IntegerThresholdView | Limit that triggers an alert when exceeded. | | typeName | string | Human-readable label that displays the alert type. | --- ##### `eventTypeName`^Optional ```typescript public readonly eventTypeName: string; ``` - *Type:* string Event type that triggers an alert. --- ##### `matchers`^Optional ```typescript public readonly matchers: Matcher[]; ``` - *Type:* Matcher[] List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. --- ##### `metricThreshold`^Optional ```typescript public readonly metricThreshold: MetricThresholdView; ``` - *Type:* MetricThresholdView Threshold for the metric that, when exceeded, triggers an alert. The resource returns this parameter when '"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"'. --- ##### `notifications`^Optional ```typescript public readonly notifications: NotificationView[]; ``` - *Type:* NotificationView[] List that contains the targets that MongoDB Cloud sends notifications. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `severityOverride`^Optional ```typescript public readonly severityOverride: string; ``` - *Type:* string Degree of seriousness given to this alert. This value overrides the default severity level for the alert. --- ##### `threshold`^Optional ```typescript public readonly threshold: IntegerThresholdView; ``` - *Type:* IntegerThresholdView Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to 'OUTSIDE_METRIC_THRESHOLD'. --- ##### `typeName`^Optional ```typescript public readonly typeName: string; ``` - *Type:* string Human-readable label that displays the alert type. --- ### CfnApiKeyProps Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. #### Initializer ```typescript import { CfnApiKeyProps } from 'awscdk-resources-mongodbatlas' const cfnApiKeyProps: CfnApiKeyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsSecretName | string | Name of the AWS Secrets Manager secret that stores the API key Details. | | description | string | Purpose or explanation provided when someone created this organization API key. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | awsSecretArn | string | ARN of the AWS Secrets Manager secret that stores the API key Details. | | listOptions | ListOptions | *No description.* | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | projectAssignments | ProjectAssignment[] | *No description.* | | roles | string[] | List of roles to grant this API key. | --- ##### `awsSecretName`^Required ```typescript public readonly awsSecretName: string; ``` - *Type:* string Name of the AWS Secrets Manager secret that stores the API key Details. --- ##### `description`^Required ```typescript public readonly description: string; ``` - *Type:* string Purpose or explanation provided when someone created this organization API key. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. --- ##### `awsSecretArn`^Optional ```typescript public readonly awsSecretArn: string; ``` - *Type:* string ARN of the AWS Secrets Manager secret that stores the API key Details. --- ##### `listOptions`^Optional ```typescript public readonly listOptions: ListOptions; ``` - *Type:* ListOptions --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `projectAssignments`^Optional ```typescript public readonly projectAssignments: ProjectAssignment[]; ``` - *Type:* ProjectAssignment[] --- ##### `roles`^Optional ```typescript public readonly roles: string[]; ``` - *Type:* string[] List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization. --- ### CfnAuditingProps Returns and edits database auditing settings for MongoDB Cloud projects. #### Initializer ```typescript import { CfnAuditingProps } from 'awscdk-resources-mongodbatlas' const cfnAuditingProps: CfnAuditingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnBackupCompliancePolicyProps Resource for managing MongoDB Atlas Backup Compliance Policy. Backup Compliance Policy prevents any user, regardless of role, from modifying or deleting specific cluster settings, backups, and backup configurations. When enabled, the Backup Compliance Policy will be applied as the minimum policy for all clusters and backups in the project. #### Initializer ```typescript import { CfnBackupCompliancePolicyProps } from 'awscdk-resources-mongodbatlas' const cfnBackupCompliancePolicyProps: CfnBackupCompliancePolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizedEmail | string | Email address of the user authorized to update the Backup Compliance Policy settings. | | authorizedUserFirstName | string | First name of the user authorized to update the Backup Compliance Policy settings. | | authorizedUserLastName | string | Last name of the user authorized to update the Backup Compliance Policy settings. | | projectId | string | The unique identifier of the project for the Backup Compliance Policy. | | copyProtectionEnabled | boolean | Flag that indicates whether to enable additional copy protection for the cluster. | | encryptionAtRestEnabled | boolean | Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. | | onDemandPolicyItem | OnDemandPolicyItem | On-demand backup policy item configuration. | | pitEnabled | boolean | Flag that indicates whether the cluster uses Continuous Cloud Backup. | | policyItemDaily | ScheduledPolicyItem | Daily backup policy item configuration. | | policyItemHourly | ScheduledPolicyItem | Hourly backup policy item configuration. | | policyItemMonthly | ScheduledPolicyItem[] | Monthly backup policy item configuration. | | policyItemWeekly | ScheduledPolicyItem[] | Weekly backup policy item configuration. | | policyItemYearly | ScheduledPolicyItem[] | Yearly backup policy item configuration. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | restoreWindowDays | number | Number of days back in time you can restore to with Continuous Cloud Backup accuracy. | --- ##### `authorizedEmail`^Required ```typescript public readonly authorizedEmail: string; ``` - *Type:* string Email address of the user authorized to update the Backup Compliance Policy settings. --- ##### `authorizedUserFirstName`^Required ```typescript public readonly authorizedUserFirstName: string; ``` - *Type:* string First name of the user authorized to update the Backup Compliance Policy settings. --- ##### `authorizedUserLastName`^Required ```typescript public readonly authorizedUserLastName: string; ``` - *Type:* string Last name of the user authorized to update the Backup Compliance Policy settings. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string The unique identifier of the project for the Backup Compliance Policy. --- ##### `copyProtectionEnabled`^Optional ```typescript public readonly copyProtectionEnabled: boolean; ``` - *Type:* boolean - *Default:* false if not specified. Flag that indicates whether to enable additional copy protection for the cluster. If enabled, cloud backup snapshots cannot be deleted until the retention period expires. Defaults to false if not specified. --- ##### `encryptionAtRestEnabled`^Optional ```typescript public readonly encryptionAtRestEnabled: boolean; ``` - *Type:* boolean - *Default:* false if not specified. Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. Defaults to false if not specified. --- ##### `onDemandPolicyItem`^Optional ```typescript public readonly onDemandPolicyItem: OnDemandPolicyItem; ``` - *Type:* OnDemandPolicyItem On-demand backup policy item configuration. --- ##### `pitEnabled`^Optional ```typescript public readonly pitEnabled: boolean; ``` - *Type:* boolean - *Default:* false if not specified. Flag that indicates whether the cluster uses Continuous Cloud Backup. If enabled, cloud backup snapshots are taken every 6 hours. Defaults to false if not specified. --- ##### `policyItemDaily`^Optional ```typescript public readonly policyItemDaily: ScheduledPolicyItem; ``` - *Type:* ScheduledPolicyItem Daily backup policy item configuration. Only one daily policy item is allowed. --- ##### `policyItemHourly`^Optional ```typescript public readonly policyItemHourly: ScheduledPolicyItem; ``` - *Type:* ScheduledPolicyItem Hourly backup policy item configuration. Only one hourly policy item is allowed. --- ##### `policyItemMonthly`^Optional ```typescript public readonly policyItemMonthly: ScheduledPolicyItem[]; ``` - *Type:* ScheduledPolicyItem[] Monthly backup policy item configuration. Multiple monthly policy items are allowed. --- ##### `policyItemWeekly`^Optional ```typescript public readonly policyItemWeekly: ScheduledPolicyItem[]; ``` - *Type:* ScheduledPolicyItem[] Weekly backup policy item configuration. Multiple weekly policy items are allowed. --- ##### `policyItemYearly`^Optional ```typescript public readonly policyItemYearly: ScheduledPolicyItem[]; ``` - *Type:* ScheduledPolicyItem[] Yearly backup policy item configuration. Multiple yearly policy items are allowed. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `restoreWindowDays`^Optional ```typescript public readonly restoreWindowDays: number; ``` - *Type:* number Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. This field is optional and computed from the API. --- ### CfnCloudBackUpRestoreJobsProps Returns, starts, and cancels Cloud Backup restore jobs. #### Initializer ```typescript import { CfnCloudBackUpRestoreJobsProps } from 'awscdk-resources-mongodbatlas' const cfnCloudBackUpRestoreJobsProps: CfnCloudBackUpRestoreJobsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deliveryType | CfnCloudBackUpRestoreJobsPropsDeliveryType | Type of restore job to create.The value can be any one of download,automated or point_in_time. | | instanceName | string | Human-readable label that identifies the cluster. | | instanceType | CfnCloudBackUpRestoreJobsPropsInstanceType | Type of instance specified on the Instance Name. | | projectId | string | The unique identifier of the project for the Atlas cluster. | | snapshotId | string | Unique identifier of the source snapshot ID of the restore job. | | enableSynchronousCreation | boolean | If set to true, the CloudFormation resource will wait until the job is completed, WARNING: if the snapshot has a big load of data, the cloud formation resource might take a long time to finish leading to high costs. | | links | CfnCloudBackUpRestoreJobsPropsLinks[] | One or more links to sub-resources and/or related resources. | | opLogInc | string | Oplog operation number from which to you want to restore this snapshot. | | opLogTs | string | Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. | | pointInTimeUtcSeconds | number | If you performed a Point-in-Time restores at a time specified by a Unix time in seconds since epoch, pointInTimeUTCSeconds indicates the Unix time used. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | synchronousCreationOptions | SynchronousCreationOptions | Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE. | | targetClusterName | string | Name of the target Atlas cluster to which the restore job restores the snapshot. | | targetProjectId | string | Name of the target Atlas project of the restore job. | --- ##### `deliveryType`^Required ```typescript public readonly deliveryType: CfnCloudBackUpRestoreJobsPropsDeliveryType; ``` - *Type:* CfnCloudBackUpRestoreJobsPropsDeliveryType Type of restore job to create.The value can be any one of download,automated or point_in_time. --- ##### `instanceName`^Required ```typescript public readonly instanceName: string; ``` - *Type:* string Human-readable label that identifies the cluster. --- ##### `instanceType`^Required ```typescript public readonly instanceType: CfnCloudBackUpRestoreJobsPropsInstanceType; ``` - *Type:* CfnCloudBackUpRestoreJobsPropsInstanceType Type of instance specified on the Instance Name. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string The unique identifier of the project for the Atlas cluster. --- ##### `snapshotId`^Required ```typescript public readonly snapshotId: string; ``` - *Type:* string Unique identifier of the source snapshot ID of the restore job. --- ##### `enableSynchronousCreation`^Optional ```typescript public readonly enableSynchronousCreation: boolean; ``` - *Type:* boolean If set to true, the CloudFormation resource will wait until the job is completed, WARNING: if the snapshot has a big load of data, the cloud formation resource might take a long time to finish leading to high costs. --- ##### `links`^Optional ```typescript public readonly links: CfnCloudBackUpRestoreJobsPropsLinks[]; ``` - *Type:* CfnCloudBackUpRestoreJobsPropsLinks[] One or more links to sub-resources and/or related resources. --- ##### `opLogInc`^Optional ```typescript public readonly opLogInc: string; ``` - *Type:* string Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. --- ##### `opLogTs`^Optional ```typescript public readonly opLogTs: string; ``` - *Type:* string Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp. --- ##### `pointInTimeUtcSeconds`^Optional ```typescript public readonly pointInTimeUtcSeconds: number; ``` - *Type:* number If you performed a Point-in-Time restores at a time specified by a Unix time in seconds since epoch, pointInTimeUTCSeconds indicates the Unix time used. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `synchronousCreationOptions`^Optional ```typescript public readonly synchronousCreationOptions: SynchronousCreationOptions; ``` - *Type:* SynchronousCreationOptions Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE. --- ##### `targetClusterName`^Optional ```typescript public readonly targetClusterName: string; ``` - *Type:* string Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated. --- ##### `targetProjectId`^Optional ```typescript public readonly targetProjectId: string; ``` - *Type:* string Name of the target Atlas project of the restore job. Only visible if deliveryType is automated. --- ### CfnCloudBackUpRestoreJobsPropsLinks #### Initializer ```typescript import { CfnCloudBackUpRestoreJobsPropsLinks } from 'awscdk-resources-mongodbatlas' const cfnCloudBackUpRestoreJobsPropsLinks: CfnCloudBackUpRestoreJobsPropsLinks = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | href | string | *No description.* | | rel | string | *No description.* | --- ##### `href`^Optional ```typescript public readonly href: string; ``` - *Type:* string --- ##### `rel`^Optional ```typescript public readonly rel: string; ``` - *Type:* string --- ### CfnCloudBackupScheduleProps An example resource schema demonstrating some basic constructs and validation rules. #### Initializer ```typescript import { CfnCloudBackupScheduleProps } from 'awscdk-resources-mongodbatlas' const cfnCloudBackupScheduleProps: CfnCloudBackupScheduleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoExportEnabled | boolean | Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. | | clusterName | string | The name of the Atlas cluster that contains the snapshots you want to retrieve. | | copySettings | ApiAtlasDiskBackupCopySettingView[] | List that contains a document for each copy setting item in the desired backup policy. | | deleteCopiedBackups | ApiDeleteCopiedBackupsView[] | List that contains a document for each deleted copy setting whose backup copies you want to delete. | | export | Export | Policy for automatically exporting cloud backup snapshots. | | id | string | Unique identifier of the snapshot. | | links | Link[] | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. | | policies | ApiPolicyView[] | Rules set for this backup schedule. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | projectId | string | The unique identifier of the project for the Atlas cluster. | | referenceHourOfDay | number | UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot. | | referenceMinuteOfHour | number | UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot. | | restoreWindowDays | number | Number of days back in time you can restore to with Continuous Cloud Backup accuracy. | | updateSnapshots | boolean | Flag indicating if updates to retention in the backup policy were applied to snapshots that Atlas took earlier. | | useOrgAndGroupNamesInExportPrefix | boolean | Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. | --- ##### `autoExportEnabled`^Required ```typescript public readonly autoExportEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string The name of the Atlas cluster that contains the snapshots you want to retrieve. --- ##### `copySettings`^Optional ```typescript public readonly copySettings: ApiAtlasDiskBackupCopySettingView[]; ``` - *Type:* ApiAtlasDiskBackupCopySettingView[] List that contains a document for each copy setting item in the desired backup policy. --- ##### `deleteCopiedBackups`^Optional ```typescript public readonly deleteCopiedBackups: ApiDeleteCopiedBackupsView[]; ``` - *Type:* ApiDeleteCopiedBackupsView[] List that contains a document for each deleted copy setting whose backup copies you want to delete. --- ##### `export`^Optional ```typescript public readonly export: Export; ``` - *Type:* Export Policy for automatically exporting cloud backup snapshots. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the snapshot. --- ##### `links`^Optional ```typescript public readonly links: Link[]; ``` - *Type:* Link[] List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. --- ##### `policies`^Optional ```typescript public readonly policies: ApiPolicyView[]; ``` - *Type:* ApiPolicyView[] Rules set for this backup schedule. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string The unique identifier of the project for the Atlas cluster. --- ##### `referenceHourOfDay`^Optional ```typescript public readonly referenceHourOfDay: number; ``` - *Type:* number UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot. --- ##### `referenceMinuteOfHour`^Optional ```typescript public readonly referenceMinuteOfHour: number; ``` - *Type:* number UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot. --- ##### `restoreWindowDays`^Optional ```typescript public readonly restoreWindowDays: number; ``` - *Type:* number Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. --- ##### `updateSnapshots`^Optional ```typescript public readonly updateSnapshots: boolean; ``` - *Type:* boolean Flag indicating if updates to retention in the backup policy were applied to snapshots that Atlas took earlier. --- ##### `useOrgAndGroupNamesInExportPrefix`^Optional ```typescript public readonly useOrgAndGroupNamesInExportPrefix: boolean; ``` - *Type:* boolean Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. --- ### CfnCloudBackupSnapshotExportBucketProps The exportBuckets resource allows you to grant Atlas access to the specified bucket for exporting backup snapshots. #### Initializer ```typescript import { CfnCloudBackupSnapshotExportBucketProps } from 'awscdk-resources-mongodbatlas' const cfnCloudBackupSnapshotExportBucketProps: CfnCloudBackupSnapshotExportBucketProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketName | string | Human-readable label that identifies the AWS bucket that the role is authorized to access. | | iamRoleId | string | Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `bucketName`^Required ```typescript public readonly bucketName: string; ``` - *Type:* string Human-readable label that identifies the AWS bucket that the role is authorized to access. --- ##### `iamRoleId`^Required ```typescript public readonly iamRoleId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ### CfnCloudBackupSnapshotProps Returns, takes, and removes Cloud Backup snapshots. #### Initializer ```typescript import { CfnCloudBackupSnapshotProps } from 'awscdk-resources-mongodbatlas' const cfnCloudBackupSnapshotProps: CfnCloudBackupSnapshotProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceName | string | Human-readable label that identifies the cluster. | | instanceType | CfnCloudBackupSnapshotPropsInstanceType | Type of instance specified on the Instance Name. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | description | string | Human-readable phrase or sentence that explains the purpose of the snapshot. | | frequencyType | CfnCloudBackupSnapshotPropsFrequencyType | 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 | number | Number of items that the response returns per page. | | members | ApiAtlasDiskBackupShardedClusterSnapshotMemberView[] | List that includes the snapshots and the cloud provider that stores the snapshots. | | pageNum | number | 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. | | profile | string | The profile is defined in AWS Secret manager. | | results | ApiAtlasDiskBackupShardedClusterSnapshotView[] | List of returned documents that MongoDB Cloud provides when completing this request. | | retentionInDays | number | Number of days that MongoDB Cloud should retain the on-demand snapshot. | | snapshotType | CfnCloudBackupSnapshotPropsSnapshotType | Human-readable label that identifies when this snapshot triggers. | | totalCount | number | Number of documents returned in this response. | --- ##### `instanceName`^Required ```typescript public readonly instanceName: string; ``` - *Type:* string Human-readable label that identifies the cluster. --- ##### `instanceType`^Required ```typescript public readonly instanceType: CfnCloudBackupSnapshotPropsInstanceType; ``` - *Type:* CfnCloudBackupSnapshotPropsInstanceType Type of instance specified on the Instance Name. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: CfnCloudBackupSnapshotPropsFrequencyType; ``` - *Type:* CfnCloudBackupSnapshotPropsFrequencyType Human-readable label that identifies how often this snapshot triggers. --- ##### `includeCount`^Optional ```typescript public readonly includeCount: boolean; ``` - *Type:* boolean Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. --- ##### `itemsPerPage`^Optional ```typescript public readonly itemsPerPage: number; ``` - *Type:* number Number of items that the response returns per page. --- ##### `members`^Optional ```typescript public readonly members: ApiAtlasDiskBackupShardedClusterSnapshotMemberView[]; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotMemberView[] List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `"type" : "SHARDED_CLUSTER"`. --- ##### `pageNum`^Optional ```typescript public readonly pageNum: number; ``` - *Type:* number Number of the page that displays the current set of the total objects that the response returns. --- ##### `policyItems`^Optional ```typescript public readonly policyItems: string[]; ``` - *Type:* string[] List that contains unique identifiers for the policy items. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `results`^Optional ```typescript public readonly results: ApiAtlasDiskBackupShardedClusterSnapshotView[]; ``` - *Type:* ApiAtlasDiskBackupShardedClusterSnapshotView[] List of returned documents that MongoDB Cloud provides when completing this request. --- ##### `retentionInDays`^Optional ```typescript public readonly retentionInDays: number; ``` - *Type:* number Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1** --- ##### `snapshotType`^Optional ```typescript public readonly snapshotType: CfnCloudBackupSnapshotPropsSnapshotType; ``` - *Type:* CfnCloudBackupSnapshotPropsSnapshotType Human-readable label that identifies when this snapshot triggers. --- ##### `totalCount`^Optional ```typescript public readonly totalCount: number; ``` - *Type:* number Number of documents returned in this response. --- ### CfnClusterOutageSimulationProps An example resource schema demonstrating some basic constructs and validation rules. #### Initializer ```typescript import { CfnClusterOutageSimulationProps } from 'awscdk-resources-mongodbatlas' const cfnClusterOutageSimulationProps: CfnClusterOutageSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Human-readable label that identifies the cluster . | | outageFilters | Filter[] | List of settings that configure your cluster regions. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | Human-readable label that identifies the project. | --- ##### `clusterName`^Required ```typescript public readonly clusterName: string; ``` - *Type:* string Human-readable label that identifies the cluster . --- ##### `outageFilters`^Required ```typescript public readonly outageFilters: Filter[]; ``` - *Type:* Filter[] List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy. --- ##### `profile`^Required ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Human-readable label that identifies the project. --- ### CfnClusterProps The cluster resource provides access to your cluster configurations. The resource lets you create, edit and delete clusters. The resource requires your Project ID. #### Initializer ```typescript import { CfnClusterProps } from 'awscdk-resources-mongodbatlas' const cfnClusterProps: CfnClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that identifies the advanced cluster. | | projectId | string | Unique identifier of the project the cluster belongs to. | | advancedSettings | ProcessArgs | *No description.* | | backupEnabled | boolean | Flag that indicates whether the cluster can perform backups. | | biConnector | CfnClusterPropsBiConnector | Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. | | clusterType | string | Configuration of nodes that comprise the cluster. | | connectionStrings | ConnectionStrings | Set of connection strings that your applications use to connect to this cluster. | | diskSizeGb | number | Storage capacity that the host's root volume possesses expressed in gigabytes. | | encryptionAtRestProvider | CfnClusterPropsEncryptionAtRestProvider | Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. | | globalClusterSelfManagedSharding | boolean | (Optional) Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). | | labels | CfnClusterPropsLabels[] | Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. | | mongoDbMajorVersion | string | Major MongoDB version of the cluster. | | paused | boolean | Flag that indicates whether the cluster is paused or not. | | pitEnabled | boolean | Flag that indicates whether the cluster uses continuous cloud backups. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | replicationSpecs | AdvancedReplicationSpec[] | List of settings that configure your cluster regions. | | rootCertType | string | Root Certificate Authority that MongoDB Cloud cluster uses. | | tags | Tag[] | List of settings that configure your cluster regions. | | terminationProtectionEnabled | boolean | Flag that indicates whether termination protection is enabled on the cluster. | | versionReleaseSystem | string | Method by which the cluster maintains the MongoDB versions. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the advanced cluster. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique identifier of the project the cluster belongs to. --- ##### `advancedSettings`^Optional ```typescript public readonly advancedSettings: ProcessArgs; ``` - *Type:* ProcessArgs --- ##### `backupEnabled`^Optional ```typescript public readonly backupEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use backups. --- ##### `biConnector`^Optional ```typescript public readonly biConnector: CfnClusterPropsBiConnector; ``` - *Type:* CfnClusterPropsBiConnector Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. --- ##### `clusterType`^Optional ```typescript public readonly clusterType: string; ``` - *Type:* string Configuration of nodes that comprise the cluster. --- ##### `connectionStrings`^Optional ```typescript public readonly connectionStrings: ConnectionStrings; ``` - *Type:* ConnectionStrings Set of connection strings that your applications use to connect to this cluster. Use the parameters in this object to connect your applications to this cluster. See the MongoDB [Connection String URI Format](https://docs.mongodb.com/manual/reference/connection-string/) reference for further details. --- ##### `diskSizeGb`^Optional ```typescript public readonly diskSizeGb: number; ``` - *Type:* number Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. --- ##### `encryptionAtRestProvider`^Optional ```typescript public readonly encryptionAtRestProvider: CfnClusterPropsEncryptionAtRestProvider; ``` - *Type:* CfnClusterPropsEncryptionAtRestProvider Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be M10 or higher and "backupEnabled" : false or omitted entirely. --- ##### `globalClusterSelfManagedSharding`^Optional ```typescript public readonly globalClusterSelfManagedSharding: boolean; ``` - *Type:* boolean (Optional) Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info [here](https://www.mongodb.com/docs/atlas/tutorial/create-global-cluster/#select-your-sharding-configuration). --- ##### `labels`^Optional ```typescript public readonly labels: CfnClusterPropsLabels[]; ``` - *Type:* CfnClusterPropsLabels[] Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. --- ##### `mongoDbMajorVersion`^Optional ```typescript public readonly mongoDbMajorVersion: string; ``` - *Type:* string Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. --- ##### `paused`^Optional ```typescript public readonly paused: boolean; ``` - *Type:* boolean Flag that indicates whether the cluster is paused or not. --- ##### `pitEnabled`^Optional ```typescript public readonly pitEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether the cluster uses continuous cloud backups. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `replicationSpecs`^Optional ```typescript public readonly replicationSpecs: AdvancedReplicationSpec[]; ``` - *Type:* AdvancedReplicationSpec[] List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy. --- ##### `rootCertType`^Optional ```typescript public readonly rootCertType: string; ``` - *Type:* string Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group. --- ##### `tags`^Optional ```typescript public readonly tags: Tag[]; ``` - *Type:* Tag[] List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy. --- ##### `terminationProtectionEnabled`^Optional ```typescript public readonly terminationProtectionEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. --- ##### `versionReleaseSystem`^Optional ```typescript public readonly versionReleaseSystem: string; ``` - *Type:* string Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion --- ### CfnClusterPropsBiConnector Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. #### Initializer ```typescript import { CfnClusterPropsBiConnector } from 'awscdk-resources-mongodbatlas' const cfnClusterPropsBiConnector: CfnClusterPropsBiConnector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster. | | readPreference | string | Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster. --- ##### `readPreference`^Optional ```typescript public readonly readPreference: string; ``` - *Type:* string - *Default:* ANALYTICS node, or SECONDARY if there are no ANALYTICS nodes. Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to ANALYTICS node, or SECONDARY if there are no ANALYTICS nodes. --- ### CfnClusterPropsLabels #### Initializer ```typescript import { CfnClusterPropsLabels } from 'awscdk-resources-mongodbatlas' const cfnClusterPropsLabels: CfnClusterPropsLabels = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | *No description.* | | value | string | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: string; ``` - *Type:* string --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string --- ### CfnCustomDbRoleProps Returns, adds, edits, and removes custom database user privilege roles. #### Initializer ```typescript import { CfnCustomDbRoleProps } from 'awscdk-resources-mongodbatlas' const cfnCustomDbRoleProps: CfnCustomDbRoleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | roleName | string | Human-readable label that identifies the role for the request. | | actions | Action[] | List of the individual privilege actions that the role grants. | | inheritedRoles | InheritedRole[] | List of the built-in roles that this custom role inherits. | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `roleName`^Required ```typescript public readonly roleName: string; ``` - *Type:* string Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. --- ##### `actions`^Optional ```typescript public readonly actions: Action[]; ``` - *Type:* Action[] List of the individual privilege actions that the role grants. --- ##### `inheritedRoles`^Optional ```typescript public readonly inheritedRoles: InheritedRole[]; ``` - *Type:* InheritedRole[] List of the built-in roles that this custom role inherits. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ### CfnCustomDnsConfigurationClusterAwsProps An example resource schema demonstrating some basic constructs and validation rules. #### Initializer ```typescript import { CfnCustomDnsConfigurationClusterAwsProps } from 'awscdk-resources-mongodbatlas' const cfnCustomDnsConfigurationClusterAwsProps: CfnCustomDnsConfigurationClusterAwsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | enabled | boolean | Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS). | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS). --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ### CfnDatabaseUserProps Returns, adds, edits, and removes database users. #### Initializer ```typescript import { CfnDatabaseUserProps } from 'awscdk-resources-mongodbatlas' const cfnDatabaseUserProps: CfnDatabaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseName | string | MongoDB database against which the MongoDB database user authenticates. | | projectId | string | Unique 24-hexadecimal digit string that identifies your Atlas Project. | | roles | RoleDefinition[] | List that provides the pairings of one role with one applicable database. | | username | string | Human-readable label that represents the user that authenticates to MongoDB. | | awsiamType | CfnDatabaseUserPropsAwsiamType | 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. | | deleteAfterDate | string | Date and time when MongoDB Cloud deletes the user. | | description | string | Description of this database user. | | labels | LabelDefinition[] | List that contains the key-value pairs for tagging and categorizing the MongoDB database user. | | ldapAuthType | CfnDatabaseUserPropsLdapAuthType | Method by which the provided username is authenticated. | | oidcAuthType | CfnDatabaseUserPropsOidcAuthType | Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. | | password | string | The user’s password. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used. | | scopes | ScopeDefinition[] | List that contains clusters and MongoDB Atlas Data Federation that this database user can access. | | x509Type | CfnDatabaseUserPropsX509Type | Method that briefs who owns the certificate provided. | --- ##### `databaseName`^Required ```typescript public readonly databaseName: string; ``` - *Type:* string 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`. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your Atlas Project. --- ##### `roles`^Required ```typescript public readonly roles: RoleDefinition[]; ``` - *Type:* RoleDefinition[] List that provides the pairings of one role with one applicable database. --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string 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. --- ##### `awsiamType`^Optional ```typescript public readonly awsiamType: CfnDatabaseUserPropsAwsiamType; ``` - *Type:* CfnDatabaseUserPropsAwsiamType 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`. --- ##### `deleteAfterDate`^Optional ```typescript public readonly deleteAfterDate: string; ``` - *Type:* string 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. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of this database user. --- ##### `labels`^Optional ```typescript public readonly labels: LabelDefinition[]; ``` - *Type:* LabelDefinition[] 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. --- ##### `ldapAuthType`^Optional ```typescript public readonly ldapAuthType: CfnDatabaseUserPropsLdapAuthType; ``` - *Type:* CfnDatabaseUserPropsLdapAuthType Method by which the provided username is authenticated. Default value is `NONE`. --- ##### `oidcAuthType`^Optional ```typescript public readonly oidcAuthType: CfnDatabaseUserPropsOidcAuthType; ``` - *Type:* CfnDatabaseUserPropsOidcAuthType Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field. Default value is `NONE`. --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string The user’s password. This field is not included in the entity returned from the server. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used. --- ##### `scopes`^Optional ```typescript public readonly scopes: ScopeDefinition[]; ``` - *Type:* ScopeDefinition[] 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. --- ##### `x509Type`^Optional ```typescript public readonly x509Type: CfnDatabaseUserPropsX509Type; ``` - *Type:* CfnDatabaseUserPropsX509Type Method that briefs who owns the certificate provided. Default value is `NONE`. --- ### CfnEncryptionAtRestProps Returns and edits the Encryption at Rest using Customer Key Management configuration. #### Initializer ```typescript import { CfnEncryptionAtRestProps } from 'awscdk-resources-mongodbatlas' const cfnEncryptionAtRestProps: CfnEncryptionAtRestProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsKmsConfig | AwsKmsConfig | *No description.* | | projectId | string | Unique identifier of the Atlas project to which the user belongs. | | enabledForSearchNodes | boolean | Flag that indicates whether Encryption at Rest for Dedicated Search Nodes is enabled in the specified project. | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `awsKmsConfig`^Required ```typescript public readonly awsKmsConfig: AwsKmsConfig; ``` - *Type:* AwsKmsConfig --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique identifier of the Atlas project to which the user belongs. --- ##### `enabledForSearchNodes`^Optional ```typescript public readonly enabledForSearchNodes: boolean; ``` - *Type:* boolean Flag that indicates whether Encryption at Rest for Dedicated Search Nodes is enabled in the specified project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ### CfnFederatedDatabaseInstanceProps Returns, adds, edits, and removes Federated Database Instances. #### Initializer ```typescript import { CfnFederatedDatabaseInstanceProps } from 'awscdk-resources-mongodbatlas' const cfnFederatedDatabaseInstanceProps: CfnFederatedDatabaseInstanceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | tenantName | string | Human-readable label that identifies the data federation. | | cloudProviderConfig | CloudProviderConfig | Cloud provider linked to this Atlas Data Federation. | | dataProcessRegion | DataProcessRegion | Information about the cloud provider region to which the Atlas Data Federation routes client connections. | | profile | string | The profile is defined in AWS Secret manager. | | skipRoleValidation | boolean | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. | | storage | Storage | Configuration information for each data store and its mapping to MongoDB Cloud databases. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `tenantName`^Required ```typescript public readonly tenantName: string; ``` - *Type:* string Human-readable label that identifies the data federation. --- ##### `cloudProviderConfig`^Optional ```typescript public readonly cloudProviderConfig: CloudProviderConfig; ``` - *Type:* CloudProviderConfig Cloud provider linked to this Atlas Data Federation. --- ##### `dataProcessRegion`^Optional ```typescript public readonly dataProcessRegion: DataProcessRegion; ``` - *Type:* DataProcessRegion Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `skipRoleValidation`^Optional ```typescript public readonly skipRoleValidation: boolean; ``` - *Type:* boolean Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. --- ##### `storage`^Optional ```typescript public readonly storage: Storage; ``` - *Type:* Storage Configuration information for each data store and its mapping to MongoDB Cloud databases. --- ### CfnFederatedQueryLimitProps Query limit for one federated database instance. #### Initializer ```typescript import { CfnFederatedQueryLimitProps } from 'awscdk-resources-mongodbatlas' const cfnFederatedQueryLimitProps: CfnFederatedQueryLimitProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limitName | CfnFederatedQueryLimitPropsLimitName | Human-readable label that identifies this data federation instance limit. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | tenantName | string | Human-readable label that identifies the data federated database instance to which the query limit applies. | | value | string | Amount to set the limit to. | | overrunPolicy | string | Action to take when the usage limit is exceeded. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `limitName`^Required ```typescript public readonly limitName: CfnFederatedQueryLimitPropsLimitName; ``` - *Type:* CfnFederatedQueryLimitPropsLimitName Human-readable label that identifies this data federation instance limit. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `tenantName`^Required ```typescript public readonly tenantName: string; ``` - *Type:* string Human-readable label that identifies the data federated database instance to which the query limit applies. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string Amount to set the limit to. --- ##### `overrunPolicy`^Optional ```typescript public readonly overrunPolicy: string; ``` - *Type:* string Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnFederatedSettingsIdentityProviderProps Resource for managing MongoDB Atlas Federated Settings Identity Providers (SAML and OIDC) within an Atlas federation. #### Initializer ```typescript import { CfnFederatedSettingsIdentityProviderProps } from 'awscdk-resources-mongodbatlas' const cfnFederatedSettingsIdentityProviderProps: CfnFederatedSettingsIdentityProviderProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | federationSettingsId | string | Unique 24-hexadecimal digit string that identifies your federation. | | issuerUri | string | Issuer URI of the identity provider. | | name | string | Human-readable name (display name) of the identity provider. | | associatedDomains | string[] | List of associated domains for this identity provider. | | audience | string | OIDC audience. | | authorizationType | string | OIDC authorization type. | | clientId | string | OIDC client ID. | | description | string | Description of the identity provider. | | groupsClaim | string | OIDC groups claim. | | idpType | string | Identity provider type (for OIDC). | | profile | string | The profile is defined in AWS Secrets Manager. | | protocol | CfnFederatedSettingsIdentityProviderPropsProtocol | Identity provider protocol. | | requestBinding | string | SAML request binding. | | requestedScopes | string[] | OIDC requested scopes. | | responseSignatureAlgorithm | string | SAML response signature algorithm. | | ssoDebugEnabled | boolean | Flag that indicates whether to enable SSO debug. | | ssoUrl | string | SSO URL. | | status | string | Identity provider status. | | userClaim | string | OIDC user claim. | --- ##### `federationSettingsId`^Required ```typescript public readonly federationSettingsId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your federation. --- ##### `issuerUri`^Required ```typescript public readonly issuerUri: string; ``` - *Type:* string Issuer URI of the identity provider. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable name (display name) of the identity provider. --- ##### `associatedDomains`^Optional ```typescript public readonly associatedDomains: string[]; ``` - *Type:* string[] List of associated domains for this identity provider. --- ##### `audience`^Optional ```typescript public readonly audience: string; ``` - *Type:* string OIDC audience. --- ##### `authorizationType`^Optional ```typescript public readonly authorizationType: string; ``` - *Type:* string OIDC authorization type. --- ##### `clientId`^Optional ```typescript public readonly clientId: string; ``` - *Type:* string OIDC client ID. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the identity provider. --- ##### `groupsClaim`^Optional ```typescript public readonly groupsClaim: string; ``` - *Type:* string OIDC groups claim. --- ##### `idpType`^Optional ```typescript public readonly idpType: string; ``` - *Type:* string Identity provider type (for OIDC). --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secrets Manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `protocol`^Optional ```typescript public readonly protocol: CfnFederatedSettingsIdentityProviderPropsProtocol; ``` - *Type:* CfnFederatedSettingsIdentityProviderPropsProtocol Identity provider protocol. --- ##### `requestBinding`^Optional ```typescript public readonly requestBinding: string; ``` - *Type:* string SAML request binding. --- ##### `requestedScopes`^Optional ```typescript public readonly requestedScopes: string[]; ``` - *Type:* string[] OIDC requested scopes. --- ##### `responseSignatureAlgorithm`^Optional ```typescript public readonly responseSignatureAlgorithm: string; ``` - *Type:* string SAML response signature algorithm. --- ##### `ssoDebugEnabled`^Optional ```typescript public readonly ssoDebugEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable SSO debug. --- ##### `ssoUrl`^Optional ```typescript public readonly ssoUrl: string; ``` - *Type:* string SSO URL. --- ##### `status`^Optional ```typescript public readonly status: string; ``` - *Type:* string Identity provider status. --- ##### `userClaim`^Optional ```typescript public readonly userClaim: string; ``` - *Type:* string OIDC user claim. --- ### CfnFederatedSettingsOrgRoleMappingProps Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. #### Initializer ```typescript import { CfnFederatedSettingsOrgRoleMappingProps } from 'awscdk-resources-mongodbatlas' const cfnFederatedSettingsOrgRoleMappingProps: CfnFederatedSettingsOrgRoleMappingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | externalGroupName | string | Unique human-readable label that identifies the identity provider group to whichthis role mapping applies. | | federationSettingsId | string | Unique 24-hexadecimal digit string that identifies your federation. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | profile | string | The profile is defined in AWS Secret manager. | | roleAssignments | RoleAssignment[] | Atlas roles and the unique identifiers of the groups and organizations associated with each role. | --- ##### `externalGroupName`^Required ```typescript public readonly externalGroupName: string; ``` - *Type:* string Unique human-readable label that identifies the identity provider group to whichthis role mapping applies. --- ##### `federationSettingsId`^Required ```typescript public readonly federationSettingsId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your federation. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `roleAssignments`^Optional ```typescript public readonly roleAssignments: RoleAssignment[]; ``` - *Type:* RoleAssignment[] Atlas roles and the unique identifiers of the groups and organizations associated with each role. --- ### CfnFlexClusterProps The flex cluster resource provides access to your flex cluster configurations. The resource lets you create, edit and delete flex clusters. The resource requires your Project ID. #### Initializer ```typescript import { CfnFlexClusterProps } from 'awscdk-resources-mongodbatlas' const cfnFlexClusterProps: CfnFlexClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that identifies the flex cluster. | | projectId | string | Unique identifier of the project the cluster belongs to. | | providerSettings | ProviderSettings | *No description.* | | backupSettings | BackupSettings | *No description.* | | connectionStrings | ConnectionStrings | *No description.* | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | tags | Tag[] | Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the flex cluster. | | terminationProtectionEnabled | boolean | Flag that indicates whether termination protection is enabled on the cluster. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the flex cluster. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique identifier of the project the cluster belongs to. --- ##### `providerSettings`^Required ```typescript public readonly providerSettings: ProviderSettings; ``` - *Type:* ProviderSettings --- ##### `backupSettings`^Optional ```typescript public readonly backupSettings: BackupSettings; ``` - *Type:* BackupSettings --- ##### `connectionStrings`^Optional ```typescript public readonly connectionStrings: ConnectionStrings; ``` - *Type:* ConnectionStrings --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `tags`^Optional ```typescript public readonly tags: Tag[]; ``` - *Type:* Tag[] Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the flex cluster. --- ##### `terminationProtectionEnabled`^Optional ```typescript public readonly terminationProtectionEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. --- ### CfnGlobalClusterConfigProps Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. This resource can only be used with Atlas-managed clusters, see doc for `GlobalClusterSelfManagedSharding` attribute in `Mongodb::Atlas::Cluster` resource for more info. #### Initializer ```typescript import { CfnGlobalClusterConfigProps } from 'awscdk-resources-mongodbatlas' const cfnGlobalClusterConfigProps: CfnGlobalClusterConfigProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | The name of the Atlas cluster that contains the snapshots you want to retrieve. | | customZoneMappings | ZoneMapping[] | List that contains comma-separated key value pairs to map zones to geographic regions. | | managedNamespaces | ManagedNamespace[] | List that contains comma-separated key value pairs to map zones to geographic regions. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | The unique identifier of the project for the Atlas cluster. | --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string The name of the Atlas cluster that contains the snapshots you want to retrieve. --- ##### `customZoneMappings`^Optional ```typescript public readonly customZoneMappings: ZoneMapping[]; ``` - *Type:* ZoneMapping[] List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings. This parameter returns an empty object if no custom zones exist. --- ##### `managedNamespaces`^Optional ```typescript public readonly managedNamespaces: ManagedNamespace[]; ``` - *Type:* ManagedNamespace[] List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings. This parameter returns an empty object if no custom zones exist. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string The unique identifier of the project for the Atlas cluster. --- ### CfnLdapConfigurationProps Returns, edits, verifies, and removes LDAP configurations. #### Initializer ```typescript import { CfnLdapConfigurationProps } from 'awscdk-resources-mongodbatlas' const cfnLdapConfigurationProps: CfnLdapConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bindPassword | string | Password that MongoDB Cloud uses to authenticate the **bindUsername**. | | bindUsername | string | Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. | | hostname | string | Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. | | port | number | Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | authenticationEnabled | boolean | Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host. | | authorizationEnabled | boolean | Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host. | | authzQueryTemplate | string | Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. | | caCertificate | string | Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | status | string | The current status of the LDAP over TLS/SSL configuration. | | userToDnMapping | ApiAtlasNdsUserToDnMappingView[] | User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN. | --- ##### `bindPassword`^Required ```typescript public readonly bindPassword: string; ``` - *Type:* string Password that MongoDB Cloud uses to authenticate the **bindUsername**. --- ##### `bindUsername`^Required ```typescript public readonly bindUsername: string; ``` - *Type:* string Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253. --- ##### `hostname`^Required ```typescript public readonly hostname: string; ``` - *Type:* string Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `authenticationEnabled`^Optional ```typescript public readonly authenticationEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host. --- ##### `authorizationEnabled`^Optional ```typescript public readonly authorizationEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host. --- ##### `authzQueryTemplate`^Optional ```typescript public readonly authzQueryTemplate: string; ``` - *Type:* string Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://tools.ietf.org/search/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). --- ##### `caCertificate`^Optional ```typescript public readonly caCertificate: string; ``` - *Type:* string Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `"caCertificate": ""` --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `status`^Optional ```typescript public readonly status: string; ``` - *Type:* string The current status of the LDAP over TLS/SSL configuration. --- ##### `userToDnMapping`^Optional ```typescript public readonly userToDnMapping: ApiAtlasNdsUserToDnMappingView[]; ``` - *Type:* ApiAtlasNdsUserToDnMappingView[] User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN. --- ### CfnLdapVerifyProps Requests a verification of an LDAP configuration over TLS for an Atlas project. Pass the requestId in the response object to the Verify |ldap| Configuration endpoint to get the status of a verification request. Atlas retains only the most recent request for each project. #### Initializer ```typescript import { CfnLdapVerifyProps } from 'awscdk-resources-mongodbatlas' const cfnLdapVerifyProps: CfnLdapVerifyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bindPassword | string | Password that MongoDB Cloud uses to authenticate the **bindUsername**. | | bindUsername | string | Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. | | hostName | string | Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. | | port | number | Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | authzQueryTemplate | string | Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. | | caCertificate | string | Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | validations | Validation[] | List of validation messages related to the verification of the provided LDAP over TLS configuration details. | --- ##### `bindPassword`^Required ```typescript public readonly bindPassword: string; ``` - *Type:* string Password that MongoDB Cloud uses to authenticate the **bindUsername**. --- ##### `bindUsername`^Required ```typescript public readonly bindUsername: string; ``` - *Type:* string Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253. --- ##### `hostName`^Required ```typescript public readonly hostName: string; ``` - *Type:* string Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `authzQueryTemplate`^Optional ```typescript public readonly authzQueryTemplate: string; ``` - *Type:* string Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://tools.ietf.org/search/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). --- ##### `caCertificate`^Optional ```typescript public readonly caCertificate: string; ``` - *Type:* string Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `"caCertificate": ""` --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `validations`^Optional ```typescript public readonly validations: Validation[]; ``` - *Type:* Validation[] List of validation messages related to the verification of the provided LDAP over TLS configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. --- ### CfnLogIntegrationProps The log integration resource provides access to push-based log export configurations for MongoDB Atlas. The resource allows you to create, edit and delete log export integrations (e.g. to cloud storage or log services). This release supports S3 integration; additional integration types will be added as the API supports them. The resource requires your Project ID. #### Initializer ```typescript import { CfnLogIntegrationProps } from 'awscdk-resources-mongodbatlas' const cfnLogIntegrationProps: CfnLogIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketName | string | Human-readable label that identifies the bucket (or storage container) name for storing log files. | | iamRoleId | string | Unique 24-hexadecimal digit string that identifies the AWS IAM role that MongoDB Cloud uses to access your S3 bucket. | | logTypes | string[] | Array of log types to export. | | prefixPath | string | Path prefix where log files will be stored. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | type | string | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. | | kmsKey | string | AWS KMS key ID or ARN for server-side encryption (optional). | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `bucketName`^Required ```typescript public readonly bucketName: string; ``` - *Type:* string Human-readable label that identifies the bucket (or storage container) name for storing log files. --- ##### `iamRoleId`^Required ```typescript public readonly iamRoleId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the AWS IAM role that MongoDB Cloud uses to access your S3 bucket. --- ##### `logTypes`^Required ```typescript public readonly logTypes: string[]; ``` - *Type:* string[] Array of log types to export. Valid values depend on the integration type (e.g. MONGOD, MONGOS, MONGOD_AUDIT, MONGOS_AUDIT for S3). --- ##### `prefixPath`^Required ```typescript public readonly prefixPath: string; ``` - *Type:* string Path prefix where log files will be stored. MongoDB Cloud adds further sub-directories based on the log type. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. Groups and projects are synonymous terms. Your group id is the same as your project id. --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the log integration type. --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: string; ``` - *Type:* string AWS KMS key ID or ARN for server-side encryption (optional). If not provided, uses bucket default encryption settings. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnMaintenanceWindowProps The maintenanceWindow resource provides access to retrieve or update the current Atlas project maintenance window. #### Initializer ```typescript import { CfnMaintenanceWindowProps } from 'awscdk-resources-mongodbatlas' const cfnMaintenanceWindowProps: CfnMaintenanceWindowProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dayOfWeek | number | One-based integer that represents the day of the week that the maintenance window starts. | | hourOfDay | number | Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | autoDefer | boolean | Flag that indicates whether MongoDB Cloud should automatically defer maintenance windows for one week when they occur during the defined maintenance window. | | autoDeferOnceEnabled | boolean | Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. | | defer | boolean | Flag that indicates whether to defer the maintenance window. | | profile | string | The profile is defined in AWS Secret manager. | | protectedHours | CfnMaintenanceWindowPropsProtectedHours | Protected hours during which MongoDB Cloud cannot start maintenance. | --- ##### `dayOfWeek`^Required ```typescript public readonly dayOfWeek: number; ``` - *Type:* number One-based integer that represents the day of the week that the maintenance window starts. | Value | Day of Week | |---|---| | `1` | Sunday | | `2` | Monday | | `3` | Tuesday | | `4` | Wednesday | | `5` | Thursday | | `6` | Friday | | `7` | Saturday | --- ##### `hourOfDay`^Required ```typescript public readonly hourOfDay: number; ``` - *Type:* number Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `autoDefer`^Optional ```typescript public readonly autoDefer: boolean; ``` - *Type:* boolean Flag that indicates whether MongoDB Cloud should automatically defer maintenance windows for one week when they occur during the defined maintenance window. --- ##### `autoDeferOnceEnabled`^Optional ```typescript public readonly autoDeferOnceEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. --- ##### `defer`^Optional ```typescript public readonly defer: boolean; ``` - *Type:* boolean Flag that indicates whether to defer the maintenance window. When set to true, the next scheduled maintenance will be deferred. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml) --- ##### `protectedHours`^Optional ```typescript public readonly protectedHours: CfnMaintenanceWindowPropsProtectedHours; ``` - *Type:* CfnMaintenanceWindowPropsProtectedHours Protected hours during which MongoDB Cloud cannot start maintenance. --- ### CfnMaintenanceWindowPropsProtectedHours Protected hours during which MongoDB Cloud cannot start maintenance. #### Initializer ```typescript import { CfnMaintenanceWindowPropsProtectedHours } from 'awscdk-resources-mongodbatlas' const cfnMaintenanceWindowPropsProtectedHours: CfnMaintenanceWindowPropsProtectedHours = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endHourOfDay | number | Hour of the day when protected hours end (0-23). | | startHourOfDay | number | Hour of the day when protected hours start (0-23). | --- ##### `endHourOfDay`^Optional ```typescript public readonly endHourOfDay: number; ``` - *Type:* number Hour of the day when protected hours end (0-23). --- ##### `startHourOfDay`^Optional ```typescript public readonly startHourOfDay: number; ``` - *Type:* number Hour of the day when protected hours start (0-23). --- ### CfnMongoDbEmployeeAccessGrantProps Grants temporary access to MongoDB employees for a specific cluster. This allows MongoDB support engineers to access cluster infrastructure, database logs, or app services sync data for troubleshooting purposes. #### Initializer ```typescript import { CfnMongoDbEmployeeAccessGrantProps } from 'awscdk-resources-mongodbatlas' const cfnMongoDbEmployeeAccessGrantProps: CfnMongoDbEmployeeAccessGrantProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Human-readable label that identifies this cluster. | | expirationTime | Date | Expiration date for the employee access grant in ISO 8601 date and time format in UTC. | | grantType | string | Level of access to grant to MongoDB Employees. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `clusterName`^Required ```typescript public readonly clusterName: string; ``` - *Type:* string Human-readable label that identifies this cluster. --- ##### `expirationTime`^Required ```typescript public readonly expirationTime: Date; ``` - *Type:* Date Expiration date for the employee access grant in ISO 8601 date and time format in UTC. --- ##### `grantType`^Required ```typescript public readonly grantType: string; ``` - *Type:* string Level of access to grant to MongoDB Employees. Possible values are CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE or CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnNetworkContainerProps Returns, adds, edits, and removes network peering containers. #### Initializer ```typescript import { CfnNetworkContainerProps } from 'awscdk-resources-mongodbatlas' const cfnNetworkContainerProps: CfnNetworkContainerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | atlasCidrBlock | string | IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | regionName | string | Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. | | profile | string | The profile is defined in AWS Secret manager. | | provisioned | boolean | Boolean flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | | vpcId | string | Unique string that identifies the MongoDB Cloud VPC on AWS. | --- ##### `atlasCidrBlock`^Required ```typescript public readonly atlasCidrBlock: string; ``` - *Type:* string IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS further limits the block to between the /24 and /21 ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `regionName`^Required ```typescript public readonly regionName: string; ``` - *Type:* string Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `provisioned`^Optional ```typescript public readonly provisioned: boolean; ``` - *Type:* boolean Boolean flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. --- ##### `vpcId`^Optional ```typescript public readonly vpcId: string; ``` - *Type:* string Unique string that identifies the MongoDB Cloud VPC on AWS. --- ### CfnNetworkPeeringProps Returns, adds, edits, and removes network peering containers and peering connections. #### Initializer ```typescript import { CfnNetworkPeeringProps } from 'awscdk-resources-mongodbatlas' const cfnNetworkPeeringProps: CfnNetworkPeeringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | containerId | string | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | vpcId | string | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | | accepterRegionName | string | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. | | awsAccountId | string | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | | profile | string | The profile is defined in AWS Secret manager. | | routeTableCidrBlock | string | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | --- ##### `containerId`^Required ```typescript public readonly containerId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `vpcId`^Required ```typescript public readonly vpcId: string; ``` - *Type:* string Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. --- ##### `accepterRegionName`^Optional ```typescript public readonly accepterRegionName: string; ``` - *Type:* string Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region. --- ##### `awsAccountId`^Optional ```typescript public readonly awsAccountId: string; ``` - *Type:* string Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `routeTableCidrBlock`^Optional ```typescript public readonly routeTableCidrBlock: string; ``` - *Type:* string Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. --- ### CfnOnlineArchiveProps Returns, adds, edits, or removes an online archive. #### Initializer ```typescript import { CfnOnlineArchiveProps } from 'awscdk-resources-mongodbatlas' const cfnOnlineArchiveProps: CfnOnlineArchiveProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. | | criteria | CriteriaView | Rules by which MongoDB MongoDB Cloud archives data. | | collectionType | CfnOnlineArchivePropsCollectionType | Classification of MongoDB database collection that you want to return. | | collName | string | Human-readable label that identifies the collection for which you created the online archive. | | dbName | string | Human-readable label of the database that contains the collection that contains the online archive. | | includeCount | boolean | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | | itemsPerPage | number | Number of items that the response returns per page. | | pageNum | number | Number of the page that displays the current set of the total objects that the response returns. | | partitionFields | PartitionFieldView[] | List that contains document parameters to use to logically divide data within a collection. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | schedule | ScheduleView | Regular frequency and duration when archiving process occurs. | --- ##### `clusterName`^Required ```typescript public readonly clusterName: string; ``` - *Type:* string Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. --- ##### `criteria`^Required ```typescript public readonly criteria: CriteriaView; ``` - *Type:* CriteriaView Rules by which MongoDB MongoDB Cloud archives data. Use the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. **"criteria.type": "DATE"** selects documents to archive based on a date. **"criteria.type": "CUSTOM"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **"criteria.type": "CUSTOM"** when **"collectionType": "TIMESERIES"**. --- ##### `collectionType`^Optional ```typescript public readonly collectionType: CfnOnlineArchivePropsCollectionType; ``` - *Type:* CfnOnlineArchivePropsCollectionType Classification of MongoDB database collection that you want to return. If you set this parameter to `TIMESERIES`, set `"criteria.type" : "date"` and `"criteria.dateFormat" : "ISODATE"`. --- ##### `collName`^Optional ```typescript public readonly collName: string; ``` - *Type:* string Human-readable label that identifies the collection for which you created the online archive. --- ##### `dbName`^Optional ```typescript public readonly dbName: string; ``` - *Type:* string Human-readable label of the database that contains the collection that contains the online archive. --- ##### `includeCount`^Optional ```typescript public readonly includeCount: boolean; ``` - *Type:* boolean Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. --- ##### `itemsPerPage`^Optional ```typescript public readonly itemsPerPage: number; ``` - *Type:* number Number of items that the response returns per page. --- ##### `pageNum`^Optional ```typescript public readonly pageNum: number; ``` - *Type:* number Number of the page that displays the current set of the total objects that the response returns. --- ##### `partitionFields`^Optional ```typescript public readonly partitionFields: PartitionFieldView[]; ``` - *Type:* PartitionFieldView[] List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `schedule`^Optional ```typescript public readonly schedule: ScheduleView; ``` - *Type:* ScheduleView Regular frequency and duration when archiving process occurs. --- ### CfnOrganizationProps Returns, adds, and edits organizational units in MongoDB Cloud. #### Initializer ```typescript import { CfnOrganizationProps } from 'awscdk-resources-mongodbatlas' const cfnOrganizationProps: CfnOrganizationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsSecretName | string | AwsSecretName used to set newly created Org credentials information. | | name | string | Human-readable label that identifies the organization. | | orgOwnerId | string | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. | | apiAccessListRequired | boolean | Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization. | | apiKey | ApiKey | *No description.* | | federatedSettingsId | string | Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. | | genAiFeaturesEnabled | boolean | Flag that indicates whether this organization has access to generative AI features. | | isDeleted | boolean | Flag that indicates whether this organization has been deleted. | | multiFactorAuthRequired | boolean | Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | restrictEmployeeAccess | boolean | Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. | | securityContact | string | Email address of the security contact for the organization. | | skipDefaultAlertsSettings | boolean | Disables automatic alert creation. | --- ##### `awsSecretName`^Required ```typescript public readonly awsSecretName: string; ``` - *Type:* string AwsSecretName used to set newly created Org credentials information. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the organization. --- ##### `orgOwnerId`^Required ```typescript public readonly orgOwnerId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide federationSettingsId, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys. --- ##### `apiAccessListRequired`^Optional ```typescript public readonly apiAccessListRequired: boolean; ``` - *Type:* boolean Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization. --- ##### `apiKey`^Optional ```typescript public readonly apiKey: ApiKey; ``` - *Type:* ApiKey --- ##### `federatedSettingsId`^Optional ```typescript public readonly federatedSettingsId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation. --- ##### `genAiFeaturesEnabled`^Optional ```typescript public readonly genAiFeaturesEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to `true`. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/ --- ##### `isDeleted`^Optional ```typescript public readonly isDeleted: boolean; ``` - *Type:* boolean Flag that indicates whether this organization has been deleted. --- ##### `multiFactorAuthRequired`^Optional ```typescript public readonly multiFactorAuthRequired: boolean; ``` - *Type:* boolean Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `restrictEmployeeAccess`^Optional ```typescript public readonly restrictEmployeeAccess: boolean; ``` - *Type:* boolean Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/. --- ##### `securityContact`^Optional ```typescript public readonly securityContact: string; ``` - *Type:* string Email address of the security contact for the organization. --- ##### `skipDefaultAlertsSettings`^Optional ```typescript public readonly skipDefaultAlertsSettings: boolean; ``` - *Type:* boolean - *Default:* true` for new Atlas Organizations created with the provider to prevent infrastructure drift caused by creation of new alerts. Disables automatic alert creation. When set to `true`, Atlas doesn't automatically create organization-level alerts. Defaults to `true` for new Atlas Organizations created with the provider to prevent infrastructure drift caused by creation of new alerts. --- ### CfnOrgInvitationProps Returns, adds, and edits organizational units in MongoDB Cloud. #### Initializer ```typescript import { CfnOrgInvitationProps } from 'awscdk-resources-mongodbatlas' const cfnOrgInvitationProps: CfnOrgInvitationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | profile | string | The profile is defined in AWS Secret manager. | | includeCount | boolean | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | | invitationId | string | Unique 24-hexadecimal digit string that identifies the invitation. | | itemsPerPage | number | Number of items that the response returns per page. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | orgName | string | Human-readable label that identifies this organization. | | pageNum | number | Number of the page that displays the current set of the total objects that the response returns. | | roles | CfnOrgInvitationPropsRoles[] | One or more organization or project level roles to assign to the MongoDB Cloud user. | | teamIds | string[] | List of unique 24-hexadecimal digit strings that identifies each team. | | totalCount | number | Number of documents returned in this response. | | username | string | Email address of the MongoDB Cloud user invited to join the organization. | --- ##### `profile`^Required ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `includeCount`^Optional ```typescript public readonly includeCount: boolean; ``` - *Type:* boolean Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. --- ##### `invitationId`^Optional ```typescript public readonly invitationId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the invitation. --- ##### `itemsPerPage`^Optional ```typescript public readonly itemsPerPage: number; ``` - *Type:* number Number of items that the response returns per page. --- ##### `orgId`^Optional ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. --- ##### `orgName`^Optional ```typescript public readonly orgName: string; ``` - *Type:* string Human-readable label that identifies this organization. --- ##### `pageNum`^Optional ```typescript public readonly pageNum: number; ``` - *Type:* number Number of the page that displays the current set of the total objects that the response returns. --- ##### `roles`^Optional ```typescript public readonly roles: CfnOrgInvitationPropsRoles[]; ``` - *Type:* CfnOrgInvitationPropsRoles[] One or more organization or project level roles to assign to the MongoDB Cloud user. --- ##### `teamIds`^Optional ```typescript public readonly teamIds: string[]; ``` - *Type:* string[] List of unique 24-hexadecimal digit strings that identifies each team. --- ##### `totalCount`^Optional ```typescript public readonly totalCount: number; ``` - *Type:* number Number of documents returned in this response. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string Email address of the MongoDB Cloud user invited to join the organization. --- ### CfnPrivateEndpointAwsProps Creates one private endpoint for the specified cloud service provider. At this current version only AWS is supported #### Initializer ```typescript import { CfnPrivateEndpointAwsProps } from 'awscdk-resources-mongodbatlas' const cfnPrivateEndpointAwsProps: CfnPrivateEndpointAwsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpointServiceId | string | Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. | | id | string | Unique string that identifies the private endpoint. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | enforceConnectionSuccess | boolean | If this proper is set to TRUE, the cloud formation resource will return success Only if the private connection is Succeeded. | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `endpointServiceId`^Required ```typescript public readonly endpointServiceId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string Unique string that identifies the private endpoint. for AWS is the VPC endpoint ID, example: vpce-xxxxxxxx --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `enforceConnectionSuccess`^Optional ```typescript public readonly enforceConnectionSuccess: boolean; ``` - *Type:* boolean If this proper is set to TRUE, the cloud formation resource will return success Only if the private connection is Succeeded. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml) --- ### CfnPrivateEndpointProps DEPRECATED- USE MongoDB::Atlas::PrivateEndpointService and MongoDB::Atlas::PrivateEndpointAWS instead, The Private Endpoint creation flow consists of the creation of three related resources in the next order: 1. Atlas Private Endpoint Service 2. Aws VPC private Endpoint 3. Atlas Private Endpoint #### Initializer ```typescript import { CfnPrivateEndpointProps } from 'awscdk-resources-mongodbatlas' const cfnPrivateEndpointProps: CfnPrivateEndpointProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | groupId | string | Unique 24-hexadecimal digit string that identifies your project. | | region | string | Aws Region. | | endpointServiceName | string | Name of the AWS PrivateLink endpoint service. | | errorMessage | string | Error message pertaining to the AWS PrivateLink connection. | | privateEndpoints | PrivateEndpoint[] | List of private endpoint associated to the service. | | profile | string | The profile is defined in AWS Secret manager. | | status | string | Status of the Atlas PrivateEndpoint service connection. | --- ##### `groupId`^Required ```typescript public readonly groupId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string Aws Region. --- ##### `endpointServiceName`^Optional ```typescript public readonly endpointServiceName: string; ``` - *Type:* string Name of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service. --- ##### `errorMessage`^Optional ```typescript public readonly errorMessage: string; ``` - *Type:* string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. --- ##### `privateEndpoints`^Optional ```typescript public readonly privateEndpoints: PrivateEndpoint[]; ``` - *Type:* PrivateEndpoint[] List of private endpoint associated to the service. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml) --- ##### `status`^Optional ```typescript public readonly status: string; ``` - *Type:* string Status of the Atlas PrivateEndpoint service connection. --- ### CfnPrivateEndPointRegionalModeProps An example resource schema demonstrating some basic constructs and validation rules. #### Initializer ```typescript import { CfnPrivateEndPointRegionalModeProps } from 'awscdk-resources-mongodbatlas' const cfnPrivateEndPointRegionalModeProps: CfnPrivateEndPointRegionalModeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnPrivateEndpointServiceProps Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. #### Initializer ```typescript import { CfnPrivateEndpointServiceProps } from 'awscdk-resources-mongodbatlas' const cfnPrivateEndpointServiceProps: CfnPrivateEndpointServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | CfnPrivateEndpointServicePropsCloudProvider | Cloud service provider that manages this private endpoint, default : AWS. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | region | string | Aws Region. | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `cloudProvider`^Required ```typescript public readonly cloudProvider: CfnPrivateEndpointServicePropsCloudProvider; ``` - *Type:* CfnPrivateEndpointServicePropsCloudProvider Cloud service provider that manages this private endpoint, default : AWS. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string Aws Region. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml) --- ### CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. #### Initializer ```typescript import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps } from 'awscdk-resources-mongodbatlas' const cfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpointId | string | Unique 22-character alphanumeric string that identifies the private endpoint.Reg ex ^vpce-[0-9a-f]{17}$ . | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | comment | string | Human-readable string to associate with this private endpoint. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | type | string | Human-readable label that identifies the resource type associated with this private endpoint. | --- ##### `endpointId`^Required ```typescript public readonly endpointId: string; ``` - *Type:* string Unique 22-character alphanumeric string that identifies the private endpoint.Reg ex ^vpce-[0-9a-f]{17}$ . Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string Human-readable string to associate with this private endpoint. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Human-readable label that identifies the resource type associated with this private endpoint. --- ### CfnProjectInvitationProps Returns, adds, and edits collections of clusters and users in MongoDB Cloud. #### Initializer ```typescript import { CfnProjectInvitationProps } from 'awscdk-resources-mongodbatlas' const cfnProjectInvitationProps: CfnProjectInvitationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | invitationId | string | Unique 24-hexadecimal digit string that identifies the invitation. | | pageNum | number | Number of the page that displays the current set of the total objects that the response returns. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | roles | CfnProjectInvitationPropsRoles[] | One or more organization or project level roles to assign to the MongoDB Cloud user. | | totalCount | number | Number of documents returned in this response. | | username | string | Email address of the user account invited to this project. | --- ##### `invitationId`^Optional ```typescript public readonly invitationId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the invitation. --- ##### `pageNum`^Optional ```typescript public readonly pageNum: number; ``` - *Type:* number Number of the page that displays the current set of the total objects that the response returns. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `roles`^Optional ```typescript public readonly roles: CfnProjectInvitationPropsRoles[]; ``` - *Type:* CfnProjectInvitationPropsRoles[] One or more organization or project level roles to assign to the MongoDB Cloud user. --- ##### `totalCount`^Optional ```typescript public readonly totalCount: number; ``` - *Type:* number Number of documents returned in this response. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string Email address of the user account invited to this project. --- ### CfnProjectIpAccessListProps Returns, adds, edits, and removes network access limits to database deployments in Atlas. #### Initializer ```typescript import { CfnProjectIpAccessListProps } from 'awscdk-resources-mongodbatlas' const cfnProjectIpAccessListProps: CfnProjectIpAccessListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessList | AccessListDefinition[] | *No description.* | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | listOptions | ListOptions | *No description.* | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `accessList`^Required ```typescript public readonly accessList: AccessListDefinition[]; ``` - *Type:* AccessListDefinition[] --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `listOptions`^Optional ```typescript public readonly listOptions: ListOptions; ``` - *Type:* ListOptions --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnProjectProps Retrieves or creates projects in any given Atlas organization. #### Initializer ```typescript import { CfnProjectProps } from 'awscdk-resources-mongodbatlas' const cfnProjectProps: CfnProjectProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the project to create. | | orgId | string | Unique identifier of the organization within which to create the project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | projectApiKeys | ProjectApiKey[] | API keys that you assigned to the specified project. | | projectOwnerId | string | Unique identifier of the organization within which to create the project. | | projectSettings | ProjectSettings | *No description.* | | projectTeams | ProjectTeam[] | Teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. | | regionUsageRestrictions | string | Region usage restrictions that designate the project's AWS region.Enum: "GOV_REGIONS_ONLY" "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "NONE". | | tags | any | *No description.* | | withDefaultAlertsSettings | boolean | Flag that indicates whether to create the project with default alert settings. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the project to create. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique identifier of the organization within which to create the project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `projectApiKeys`^Optional ```typescript public readonly projectApiKeys: ProjectApiKey[]; ``` - *Type:* ProjectApiKey[] API keys that you assigned to the specified project. --- ##### `projectOwnerId`^Optional ```typescript public readonly projectOwnerId: string; ``` - *Type:* string Unique identifier of the organization within which to create the project. --- ##### `projectSettings`^Optional ```typescript public readonly projectSettings: ProjectSettings; ``` - *Type:* ProjectSettings --- ##### `projectTeams`^Optional ```typescript public readonly projectTeams: ProjectTeam[]; ``` - *Type:* ProjectTeam[] Teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. --- ##### `regionUsageRestrictions`^Optional ```typescript public readonly regionUsageRestrictions: string; ``` - *Type:* string Region usage restrictions that designate the project's AWS region.Enum: "GOV_REGIONS_ONLY" "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "NONE". --- ##### `tags`^Optional ```typescript public readonly tags: any; ``` - *Type:* any --- ##### `withDefaultAlertsSettings`^Optional ```typescript public readonly withDefaultAlertsSettings: boolean; ``` - *Type:* boolean Flag that indicates whether to create the project with default alert settings. --- ### CfnProjectServiceAccountAccessListEntryProps Manages IP access list entries for MongoDB Atlas Project Service Accounts. #### Initializer ```typescript import { CfnProjectServiceAccountAccessListEntryProps } from 'awscdk-resources-mongodbatlas' const cfnProjectServiceAccountAccessListEntryProps: CfnProjectServiceAccountAccessListEntryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | The Client ID of the Service Account. | | projectId | string | Unique 24-hexadecimal digit string that identifies the project. | | cidrBlock | string | Range of IP addresses in CIDR notation to be added to the access list. | | ipAddress | string | Single IP address to be added to the access list. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `clientId`^Required ```typescript public readonly clientId: string; ``` - *Type:* string The Client ID of the Service Account. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the project. --- ##### `cidrBlock`^Optional ```typescript public readonly cidrBlock: string; ``` - *Type:* string Range of IP addresses in CIDR notation to be added to the access list. You can set a value for this parameter or IPAddress, but not both. --- ##### `ipAddress`^Optional ```typescript public readonly ipAddress: string; ``` - *Type:* string Single IP address to be added to the access list. You can set a value for this parameter or CIDRBlock, but not both. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnProjectServiceAccountProps Creates and manages a Project Service Account. This resource creates a Service Account and assigns it to a project. Note: Deleting this resource only unassigns the Service Account from the project, but doesn't delete it from the organization. #### Initializer ```typescript import { CfnProjectServiceAccountProps } from 'awscdk-resources-mongodbatlas' const cfnProjectServiceAccountProps: CfnProjectServiceAccountProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Human readable description for the Service Account. | | name | string | Human-readable name for the Service Account. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | roles | string[] | A list of project-level roles for the Service Account. | | secretExpiresAfterHours | number | Expiration time of the new Service Account secret in hours. | | profile | string | Profile used to provide credentials information. | | secrets | SecretDefinition[] | List of secrets associated with the Service Account. | --- ##### `description`^Required ```typescript public readonly description: string; ``` - *Type:* string Human readable description for the Service Account. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable name for the Service Account. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `roles`^Required ```typescript public readonly roles: string[]; ``` - *Type:* string[] A list of project-level roles for the Service Account. --- ##### `secretExpiresAfterHours`^Required ```typescript public readonly secretExpiresAfterHours: number; ``` - *Type:* number Expiration time of the new Service Account secret in hours. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information. --- ##### `secrets`^Optional ```typescript public readonly secrets: SecretDefinition[]; ``` - *Type:* SecretDefinition[] List of secrets associated with the Service Account. --- ### CfnProjectServiceAccountSecretProps Creates a secret for the specified Service Account at the project level. #### Initializer ```typescript import { CfnProjectServiceAccountSecretProps } from 'awscdk-resources-mongodbatlas' const cfnProjectServiceAccountSecretProps: CfnProjectServiceAccountSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | The Client ID of the Service Account. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | secretExpiresAfterHours | number | The expiration time of the new Service Account secret, provided in hours. | --- ##### `clientId`^Required ```typescript public readonly clientId: string; ``` - *Type:* string The Client ID of the Service Account. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `secretExpiresAfterHours`^Optional ```typescript public readonly secretExpiresAfterHours: number; ``` - *Type:* number The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. --- ### CfnResourcePolicyProps Atlas Resource Policies. #### Initializer ```typescript import { CfnResourcePolicyProps } from 'awscdk-resources-mongodbatlas' const cfnResourcePolicyProps: CfnResourcePolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that describes the atlas resource policy. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | policies | ApiAtlasPolicy[] | List of policies that make up the atlas resource policy. | | createdByUser | ApiAtlasUserMetadata | The user that last updated the atlas resource policy. | | description | string | Description of the Atlas resource policy. | | lastUpdatedByUser | ApiAtlasUserMetadata | The user that last updated the atlas resource policy. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that describes the atlas resource policy. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. --- ##### `policies`^Required ```typescript public readonly policies: ApiAtlasPolicy[]; ``` - *Type:* ApiAtlasPolicy[] List of policies that make up the atlas resource policy. --- ##### `createdByUser`^Optional ```typescript public readonly createdByUser: ApiAtlasUserMetadata; ``` - *Type:* ApiAtlasUserMetadata The user that last updated the atlas resource policy. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the Atlas resource policy. --- ##### `lastUpdatedByUser`^Optional ```typescript public readonly lastUpdatedByUser: ApiAtlasUserMetadata; ``` - *Type:* ApiAtlasUserMetadata The user that last updated the atlas resource policy. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnSearchDeploymentProps The resource lets you create, edit and delete dedicated search nodes in a cluster. For details on supported cloud providers and existing limitations you can visit the Search Node Documentation: https://www.mongodb.com/docs/atlas/cluster-config/multi-cloud-distribution/#search-nodes-for-workload-isolation. Only a single search deployment resource can be defined for each cluster. #### Initializer ```typescript import { CfnSearchDeploymentProps } from 'awscdk-resources-mongodbatlas' const cfnSearchDeploymentProps: CfnSearchDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Label that identifies the cluster to return the search nodes for. | | projectId | string | Unique 24-hexadecimal character string that identifies the project. | | specs | ApiSearchDeploymentSpec[] | List of settings that configure the search nodes for your cluster. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `clusterName`^Required ```typescript public readonly clusterName: string; ``` - *Type:* string Label that identifies the cluster to return the search nodes for. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the project. --- ##### `specs`^Required ```typescript public readonly specs: ApiSearchDeploymentSpec[]; ``` - *Type:* ApiSearchDeploymentSpec[] List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnSearchIndexProps Returns, adds, edits, and removes Atlas Search indexes. Also returns and updates user-defined analyzers. #### Initializer ```typescript import { CfnSearchIndexProps } from 'awscdk-resources-mongodbatlas' const cfnSearchIndexProps: CfnSearchIndexProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Name of the cluster that contains the database and collection with one or more Application Search indexes. | | collectionName | string | Human-readable label that identifies the collection that contains one or more Atlas Search indexes. | | database | string | Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. | | name | string | Human-readable label that identifies this index. | | analyzer | string | Specific pre-defined method chosen to convert database field text into searchable words. | | analyzers | ApiAtlasFtsAnalyzersViewManual[] | List of user-defined methods to convert database field text into searchable words. | | fields | string | Array of [Fields](https://www.mongodb.com/docs/atlas/atlas-search/field-types/knn-vector/#std-label-fts-data-types-knn-vector) to configure this vectorSearch index. Stringify json representation of field with types and properties. Required for vector indexes. It must contain at least one **vector** type field. | | mappings | ApiAtlasFtsMappingsViewManual | Index specifications for the collection's fields. | | numPartitions | number | Number of partitions for the index. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | searchAnalyzer | string | Method applied to identify words when searching this index. | | storedSource | string | Flag that indicates whether to store the original document in the index. | | synonyms | ApiAtlasFtsSynonymMappingDefinitionView[] | Rule sets that map words to their synonyms in this index. | | type | string | Type of index: **search** or **vectorSearch**. | | typeSets | TypeSet[] | Array of type sets that define alternate types for fields in the index. | --- ##### `clusterName`^Required ```typescript public readonly clusterName: string; ``` - *Type:* string Name of the cluster that contains the database and collection with one or more Application Search indexes. --- ##### `collectionName`^Required ```typescript public readonly collectionName: string; ``` - *Type:* string Human-readable label that identifies the collection that contains one or more Atlas Search indexes. --- ##### `database`^Required ```typescript public readonly database: string; ``` - *Type:* string Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. --- ##### `analyzer`^Optional ```typescript public readonly analyzer: string; ``` - *Type:* string Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields: - extracting words - removing punctuation - removing accents - changing to lowercase - removing common words - reducing words to their root form (stemming) - changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index. --- ##### `analyzers`^Optional ```typescript public readonly analyzers: ApiAtlasFtsAnalyzersViewManual[]; ``` - *Type:* ApiAtlasFtsAnalyzersViewManual[] List of user-defined methods to convert database field text into searchable words. --- ##### `fields`^Optional ```typescript public readonly fields: string; ``` - *Type:* string Array of [Fields](https://www.mongodb.com/docs/atlas/atlas-search/field-types/knn-vector/#std-label-fts-data-types-knn-vector) to configure this vectorSearch index. Stringify json representation of field with types and properties. Required for vector indexes. It must contain at least one **vector** type field. --- ##### `mappings`^Optional ```typescript public readonly mappings: ApiAtlasFtsMappingsViewManual; ``` - *Type:* ApiAtlasFtsMappingsViewManual Index specifications for the collection's fields. --- ##### `numPartitions`^Optional ```typescript public readonly numPartitions: number; ``` - *Type:* number Number of partitions for the index. This is used to improve search performance for large datasets by distributing the index across multiple partitions. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `searchAnalyzer`^Optional ```typescript public readonly searchAnalyzer: string; ``` - *Type:* string Method applied to identify words when searching this index. --- ##### `storedSource`^Optional ```typescript public readonly storedSource: string; ``` - *Type:* string Flag that indicates whether to store the original document in the index. Can be a boolean ("true" or "false") or a stringified JSON object specifying which fields to include/exclude. When stored, this allows the index to return the original document for queries. --- ##### `synonyms`^Optional ```typescript public readonly synonyms: ApiAtlasFtsSynonymMappingDefinitionView[]; ``` - *Type:* ApiAtlasFtsSynonymMappingDefinitionView[] Rule sets that map words to their synonyms in this index. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Type of index: **search** or **vectorSearch**. Default type is **search**. --- ##### `typeSets`^Optional ```typescript public readonly typeSets: TypeSet[]; ``` - *Type:* TypeSet[] Array of type sets that define alternate types for fields in the index. Each type set allows you to group related fields under a common name. --- ### CfnServiceAccountAccessListEntryProps Manages IP access list entries for MongoDB Atlas Service Accounts at the organization level. #### Initializer ```typescript import { CfnServiceAccountAccessListEntryProps } from 'awscdk-resources-mongodbatlas' const cfnServiceAccountAccessListEntryProps: CfnServiceAccountAccessListEntryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | The Client ID of the Service Account. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization. | | cidrBlock | string | Range of IP addresses in CIDR notation to be added to the access list. | | ipAddress | string | Single IP address to be added to the access list. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `clientId`^Required ```typescript public readonly clientId: string; ``` - *Type:* string The Client ID of the Service Account. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization. --- ##### `cidrBlock`^Optional ```typescript public readonly cidrBlock: string; ``` - *Type:* string Range of IP addresses in CIDR notation to be added to the access list. You can set a value for this parameter or IPAddress, but not both. --- ##### `ipAddress`^Optional ```typescript public readonly ipAddress: string; ``` - *Type:* string Single IP address to be added to the access list. You can set a value for this parameter or CIDRBlock, but not both. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnServiceAccountProjectAssignmentProps Assigns a Service Account to a Project with specified roles in MongoDB Atlas. #### Initializer ```typescript import { CfnServiceAccountProjectAssignmentProps } from 'awscdk-resources-mongodbatlas' const cfnServiceAccountProjectAssignmentProps: CfnServiceAccountProjectAssignmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | The Client ID of the Service Account. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | roles | string[] | The Project permissions for the Service Account in the specified Project. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | --- ##### `clientId`^Required ```typescript public readonly clientId: string; ``` - *Type:* string The Client ID of the Service Account. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `roles`^Required ```typescript public readonly roles: string[]; ``` - *Type:* string[] The Project permissions for the Service Account in the specified Project. --- ##### `orgId`^Optional ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization. Required for List operation. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ### CfnServiceAccountProps Creates and manages a Service Account for an organization. #### Initializer ```typescript import { CfnServiceAccountProps } from 'awscdk-resources-mongodbatlas' const cfnServiceAccountProps: CfnServiceAccountProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Human readable description for the Service Account. | | name | string | Human-readable name for the Service Account. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization. | | roles | string[] | List of organization-level roles for the Service Account. | | secretExpiresAfterHours | number | Expiration time of the new Service Account secret in hours. | | profile | string | Profile used to provide credentials information. | | secrets | Secret[] | List of secrets associated with the Service Account. | --- ##### `description`^Required ```typescript public readonly description: string; ``` - *Type:* string Human readable description for the Service Account. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable name for the Service Account. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization. --- ##### `roles`^Required ```typescript public readonly roles: string[]; ``` - *Type:* string[] List of organization-level roles for the Service Account. --- ##### `secretExpiresAfterHours`^Required ```typescript public readonly secretExpiresAfterHours: number; ``` - *Type:* number Expiration time of the new Service Account secret in hours. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information. --- ##### `secrets`^Optional ```typescript public readonly secrets: Secret[]; ``` - *Type:* Secret[] List of secrets associated with the Service Account. --- ### CfnServiceAccountSecretProps Creates a secret for the specified Service Account at the organization level. #### Initializer ```typescript import { CfnServiceAccountSecretProps } from 'awscdk-resources-mongodbatlas' const cfnServiceAccountSecretProps: CfnServiceAccountSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | The Client ID of the Service Account. | | orgId | string | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | secretExpiresAfterHours | number | The expiration time of the new Service Account secret, provided in hours. | --- ##### `clientId`^Required ```typescript public readonly clientId: string; ``` - *Type:* string The Client ID of the Service Account. --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the organization that contains your projects. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `secretExpiresAfterHours`^Optional ```typescript public readonly secretExpiresAfterHours: number; ``` - *Type:* number The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. --- ### CfnStreamConnectionProps Returns, adds, edits, and removes one connection for a stream workspace in the specified project. To use this resource, the requesting API Key must have the Project Owner roles. #### Initializer ```typescript import { CfnStreamConnectionProps } from 'awscdk-resources-mongodbatlas' const cfnStreamConnectionProps: CfnStreamConnectionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionName | string | Human-readable label that identifies the stream connection. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | type | CfnStreamConnectionPropsType | Type of the connection. | | authentication | StreamsKafkaAuthentication | *No description.* | | aws | Aws | *No description.* | | bootstrapServers | string | Comma separated list of server addresses. | | clusterName | string | Name of the cluster configured for this connection. | | clusterProjectId | string | Unique 24-hexadecimal digit string that identifies the project containing the cluster for cross-project cluster connections. | | config | any | *No description.* | | dbRoleToExecute | DbRoleToExecute | *No description.* | | headers | any | HTTP headers for HTTPS type connections. | | instanceName | string | Human-readable label that identifies the stream instance. | | networking | Networking | *No description.* | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | provider | string | The Schema Registry provider. | | schemaRegistryAuthentication | SchemaRegistryAuthentication | *No description.* | | schemaRegistryUrls | string[] | List of Schema Registry endpoint URLs. | | security | StreamsKafkaSecurity | *No description.* | | url | string | URL endpoint for HTTPS type connections. | | workspaceName | string | Human-readable label that identifies the stream workspace. | --- ##### `connectionName`^Required ```typescript public readonly connectionName: string; ``` - *Type:* string Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. --- ##### `type`^Required ```typescript public readonly type: CfnStreamConnectionPropsType; ``` - *Type:* CfnStreamConnectionPropsType Type of the connection. Can be Cluster, Kafka, Sample, AWSLambda, or Https. --- ##### `authentication`^Optional ```typescript public readonly authentication: StreamsKafkaAuthentication; ``` - *Type:* StreamsKafkaAuthentication --- ##### `aws`^Optional ```typescript public readonly aws: Aws; ``` - *Type:* Aws --- ##### `bootstrapServers`^Optional ```typescript public readonly bootstrapServers: string; ``` - *Type:* string Comma separated list of server addresses. --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string Name of the cluster configured for this connection. --- ##### `clusterProjectId`^Optional ```typescript public readonly clusterProjectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the project containing the cluster for cross-project cluster connections. --- ##### `config`^Optional ```typescript public readonly config: any; ``` - *Type:* any --- ##### `dbRoleToExecute`^Optional ```typescript public readonly dbRoleToExecute: DbRoleToExecute; ``` - *Type:* DbRoleToExecute --- ##### `headers`^Optional ```typescript public readonly headers: any; ``` - *Type:* any HTTP headers for HTTPS type connections. --- ##### `instanceName`^Optional ```typescript public readonly instanceName: string; ``` - *Type:* string Human-readable label that identifies the stream instance. WARNING: This field is deprecated and will be removed in the next major release. Please use WorkspaceName instead. --- ##### `networking`^Optional ```typescript public readonly networking: Networking; ``` - *Type:* Networking --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `provider`^Optional ```typescript public readonly provider: string; ``` - *Type:* string The Schema Registry provider. --- ##### `schemaRegistryAuthentication`^Optional ```typescript public readonly schemaRegistryAuthentication: SchemaRegistryAuthentication; ``` - *Type:* SchemaRegistryAuthentication --- ##### `schemaRegistryUrls`^Optional ```typescript public readonly schemaRegistryUrls: string[]; ``` - *Type:* string[] List of Schema Registry endpoint URLs. Each URL must use the http or https scheme and specify a valid host and optional port. --- ##### `security`^Optional ```typescript public readonly security: StreamsKafkaSecurity; ``` - *Type:* StreamsKafkaSecurity --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string URL endpoint for HTTPS type connections. --- ##### `workspaceName`^Optional ```typescript public readonly workspaceName: string; ``` - *Type:* string Human-readable label that identifies the stream workspace. --- ### CfnStreamInstanceProps Returns, adds, edits, and removes Atlas Stream Processing Instances. #### Initializer ```typescript import { CfnStreamInstanceProps } from 'awscdk-resources-mongodbatlas' const cfnStreamInstanceProps: CfnStreamInstanceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataProcessRegion | StreamsDataProcessRegion | *No description.* | | instanceName | string | Human-readable label that identifies the stream connection. | | projectId | string | Unique 24-hexadecimal character string that identifies the project. | | streamConfig | StreamConfig | *No description.* | | connections | StreamsConnection[] | *No description.* | | profile | string | The profile is defined in AWS Secret manager. | --- ##### `dataProcessRegion`^Required ```typescript public readonly dataProcessRegion: StreamsDataProcessRegion; ``` - *Type:* StreamsDataProcessRegion --- ##### `instanceName`^Required ```typescript public readonly instanceName: string; ``` - *Type:* string Human-readable label that identifies the stream connection. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the project. --- ##### `streamConfig`^Required ```typescript public readonly streamConfig: StreamConfig; ``` - *Type:* StreamConfig --- ##### `connections`^Optional ```typescript public readonly connections: StreamsConnection[]; ``` - *Type:* StreamsConnection[] --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ### CfnStreamPrivatelinkEndpointProps Returns, adds, and removes Atlas Stream Processing Private Link Endpoints. This resource supports AWS only. #### Initializer ```typescript import { CfnStreamPrivatelinkEndpointProps } from 'awscdk-resources-mongodbatlas' const cfnStreamPrivatelinkEndpointProps: CfnStreamPrivatelinkEndpointProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | providerName | string | Provider where the endpoint is deployed. | | vendor | string | Vendor that manages the endpoint. | | arn | string | Amazon Resource Name (ARN). | | dnsDomain | string | The domain hostname. | | dnsSubDomain | string[] | Sub-Domain name of Confluent cluster. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | region | string | The region of the Provider's cluster. | | serviceEndpointId | string | For AWS CONFLUENT cluster, this is the [VPC Endpoint service name](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). For AWS S3 vendor, this should follow the format 'com.amazonaws..s3', for example 'com.amazonaws.us-east-1.s3'. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups. --- ##### `providerName`^Required ```typescript public readonly providerName: string; ``` - *Type:* string Provider where the endpoint is deployed. For CloudFormation, this is always AWS. --- ##### `vendor`^Required ```typescript public readonly vendor: string; ``` - *Type:* string Vendor that manages the endpoint. For AWS, valid values are: MSK, CONFLUENT, and S3. --- ##### `arn`^Optional ```typescript public readonly arn: string; ``` - *Type:* string Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor. --- ##### `dnsDomain`^Optional ```typescript public readonly dnsDomain: string; ``` - *Type:* string The domain hostname. Required for AWS provider with CONFLUENT vendor. --- ##### `dnsSubDomain`^Optional ```typescript public readonly dnsSubDomain: string[]; ``` - *Type:* string[] Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array []. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string The region of the Provider's cluster. See [AWS](https://www.mongodb.com/docs/atlas/reference/amazon-aws/#stream-processing-instances) supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided ARN. --- ##### `serviceEndpointId`^Optional ```typescript public readonly serviceEndpointId: string; ``` - *Type:* string For AWS CONFLUENT cluster, this is the [VPC Endpoint service name](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). For AWS S3 vendor, this should follow the format 'com.amazonaws..s3', for example 'com.amazonaws.us-east-1.s3'. --- ### CfnStreamProcessorProps Returns, adds, edits, and removes Atlas Stream Processors. #### Initializer ```typescript import { CfnStreamProcessorProps } from 'awscdk-resources-mongodbatlas' const cfnStreamProcessorProps: CfnStreamProcessorProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pipeline | string | Stream aggregation pipeline you want to apply to your streaming data. | | processorName | string | Label that identifies the stream processor. | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | workspaceName | string | Label that identifies the stream processing workspace. | | deleteOnCreateTimeout | boolean | Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. | | desiredState | CfnStreamProcessorPropsDesiredState | The desired state of the stream processor. | | options | StreamsOptions | *No description.* | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | timeouts | Timeouts | Configurable timeouts for stream processor operations. | --- ##### `pipeline`^Required ```typescript public readonly pipeline: string; ``` - *Type:* string Stream aggregation pipeline you want to apply to your streaming data. This should be a JSON-encoded array of pipeline stages. Refer to MongoDB Atlas Docs for more information on stream aggregation pipelines. --- ##### `processorName`^Required ```typescript public readonly processorName: string; ``` - *Type:* string Label that identifies the stream processor. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. --- ##### `workspaceName`^Required ```typescript public readonly workspaceName: string; ``` - *Type:* string Label that identifies the stream processing workspace. --- ##### `deleteOnCreateTimeout`^Optional ```typescript public readonly deleteOnCreateTimeout: boolean; ``` - *Type:* boolean - *Default:* true`. Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to `true` and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to `false`, the timeout will not trigger resource deletion. If you suspect a transient error when the value is `true`, wait before retrying to allow resource deletion to finish. Default is `true`. --- ##### `desiredState`^Optional ```typescript public readonly desiredState: CfnStreamProcessorPropsDesiredState; ``` - *Type:* CfnStreamProcessorPropsDesiredState The desired state of the stream processor. Used to start or stop the Stream Processor. Valid values are CREATED, STARTED or STOPPED. When a Stream Processor is created without specifying the desired state, it will default to CREATED state. When a Stream Processor is updated without specifying the desired state, it will default to the Previous state. **NOTE** When a Stream Processor is updated without specifying the desired state, it is stopped and then restored to previous state upon update completion. --- ##### `options`^Optional ```typescript public readonly options: StreamsOptions; ``` - *Type:* StreamsOptions --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `timeouts`^Optional ```typescript public readonly timeouts: Timeouts; ``` - *Type:* Timeouts Configurable timeouts for stream processor operations. --- ### CfnStreamWorkspaceProps Returns, adds, updates, and removes Atlas Stream Processing Workspaces. The DataProcessRegion.Region property can be updated after creation. Other properties (WorkspaceName, ProjectId, Profile, StreamConfig, DataProcessRegion.CloudProvider) are create-only and require resource replacement to change. #### Initializer ```typescript import { CfnStreamWorkspaceProps } from 'awscdk-resources-mongodbatlas' const cfnStreamWorkspaceProps: CfnStreamWorkspaceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataProcessRegion | StreamsDataProcessRegion | *No description.* | | projectId | string | Unique 24-hexadecimal character string that identifies the project. | | workspaceName | string | Human-readable label that identifies the stream workspace. | | profile | string | The profile is defined in AWS Secret manager. | | streamConfig | StreamConfig | *No description.* | --- ##### `dataProcessRegion`^Required ```typescript public readonly dataProcessRegion: StreamsDataProcessRegion; ``` - *Type:* StreamsDataProcessRegion --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the project. --- ##### `workspaceName`^Required ```typescript public readonly workspaceName: string; ``` - *Type:* string Human-readable label that identifies the stream workspace. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `streamConfig`^Optional ```typescript public readonly streamConfig: StreamConfig; ``` - *Type:* StreamConfig --- ### CfnTeamsProps Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List. #### Initializer ```typescript import { CfnTeamsProps } from 'awscdk-resources-mongodbatlas' const cfnTeamsProps: CfnTeamsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that identifies the team. | | orgId | string | Unique 24-hexadecimal character string that identifies the organization. | | profile | string | The profile is defined in AWS Secret manager. | | projectId | string | Unique 24-hexadecimal character string that identifies the project. | | roleNames | CfnTeamsPropsRoleNames[] | One or more organization- or project-level roles to assign to the MongoDB Cloud user. | | usernames | string[] | List that contains the MongoDB Cloud users in this team. | | users | AtlasUser[] | List of returned documents that MongoDB Cloud provides when completing this request. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the team. --- ##### `orgId`^Optional ```typescript public readonly orgId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the organization. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the project. --- ##### `roleNames`^Optional ```typescript public readonly roleNames: CfnTeamsPropsRoleNames[]; ``` - *Type:* CfnTeamsPropsRoleNames[] One or more organization- or project-level roles to assign to the MongoDB Cloud user. --- ##### `usernames`^Optional ```typescript public readonly usernames: string[]; ``` - *Type:* string[] List that contains the MongoDB Cloud users in this team. --- ##### `users`^Optional ```typescript public readonly users: AtlasUser[]; ``` - *Type:* AtlasUser[] List of returned documents that MongoDB Cloud provides when completing this request. --- ### CfnThirdPartyIntegrationProps Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. #### Initializer ```typescript import { CfnThirdPartyIntegrationProps } from 'awscdk-resources-mongodbatlas' const cfnThirdPartyIntegrationProps: CfnThirdPartyIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | type | CfnThirdPartyIntegrationPropsType | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. | | apiKey | string | Key that allows MongoDB Cloud to access your Opsgenie/Datadog account. | | apiToken | string | Key that allows MongoDB Cloud to access your Slack account. | | channelName | string | Name of the Slack channel to which MongoDB Cloud sends alert notifications. | | enabled | boolean | Flag that indicates whether someone has activated the Prometheus integration. | | listenAddress | string | Combination of IPv4 address and Internet Assigned Numbers Authority (IANA) port or the IANA port alone to which Prometheus binds to ingest MongoDB metrics. | | microsoftTeamsWebhookUrl | string | Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. | | password | string | Password required for your integration with Prometheus. | | profile | string | The profile is defined in AWS Secret manager. | | region | string | Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie/Datadog API. | | routingKey | string | Routing key associated with your Splunk On-Call account. | | secret | string | Parameter returned if someone configure this webhook with a secret. | | sendCollectionLatencyMetrics | boolean | Flag that indicates whether to send collection latency metrics to Datadog, including database names, collection names, and latency metrics on reads, writes, commands, and transactions. | | sendDatabaseMetrics | boolean | Flag that indicates whether to send database metrics to Datadog, including database names and metrics on the number of collections, storage size, and index size. | | sendUserProvidedResourceTags | boolean | Flag that indicates whether to include user-defined resource tags when sending metrics and alerts to third-party services. | | serviceDiscovery | CfnThirdPartyIntegrationPropsServiceDiscovery | Desired method to discover the Prometheus service. | | serviceKey | string | Service key associated with your PagerDuty account. | | teamName | string | Human-readable label that identifies your Slack team. | | tlsPemPath | string | Root-relative path to the Transport Layer Security (TLS) Privacy Enhanced Mail (PEM) key and certificate file on the host. | | url | string | Endpoint web address to which MongoDB Cloud sends notifications. | | userName | string | Human-readable label that identifies your Prometheus incoming webhook. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `type`^Required ```typescript public readonly type: CfnThirdPartyIntegrationPropsType; ``` - *Type:* CfnThirdPartyIntegrationPropsType Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. --- ##### `apiKey`^Optional ```typescript public readonly apiKey: string; ``` - *Type:* string Key that allows MongoDB Cloud to access your Opsgenie/Datadog account. --- ##### `apiToken`^Optional ```typescript public readonly apiToken: string; ``` - *Type:* string Key that allows MongoDB Cloud to access your Slack account. --- ##### `channelName`^Optional ```typescript public readonly channelName: string; ``` - *Type:* string Name of the Slack channel to which MongoDB Cloud sends alert notifications. --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether someone has activated the Prometheus integration. --- ##### `listenAddress`^Optional ```typescript public readonly listenAddress: string; ``` - *Type:* string Combination of IPv4 address and Internet Assigned Numbers Authority (IANA) port or the IANA port alone to which Prometheus binds to ingest MongoDB metrics. --- ##### `microsoftTeamsWebhookUrl`^Optional ```typescript public readonly microsoftTeamsWebhookUrl: string; ``` - *Type:* string Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string Password required for your integration with Prometheus. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie/Datadog API. --- ##### `routingKey`^Optional ```typescript public readonly routingKey: string; ``` - *Type:* string Routing key associated with your Splunk On-Call account. --- ##### `secret`^Optional ```typescript public readonly secret: string; ``` - *Type:* string Parameter returned if someone configure this webhook with a secret. --- ##### `sendCollectionLatencyMetrics`^Optional ```typescript public readonly sendCollectionLatencyMetrics: boolean; ``` - *Type:* boolean Flag that indicates whether to send collection latency metrics to Datadog, including database names, collection names, and latency metrics on reads, writes, commands, and transactions. --- ##### `sendDatabaseMetrics`^Optional ```typescript public readonly sendDatabaseMetrics: boolean; ``` - *Type:* boolean Flag that indicates whether to send database metrics to Datadog, including database names and metrics on the number of collections, storage size, and index size. --- ##### `sendUserProvidedResourceTags`^Optional ```typescript public readonly sendUserProvidedResourceTags: boolean; ``` - *Type:* boolean Flag that indicates whether to include user-defined resource tags when sending metrics and alerts to third-party services. --- ##### `serviceDiscovery`^Optional ```typescript public readonly serviceDiscovery: CfnThirdPartyIntegrationPropsServiceDiscovery; ``` - *Type:* CfnThirdPartyIntegrationPropsServiceDiscovery Desired method to discover the Prometheus service. --- ##### `serviceKey`^Optional ```typescript public readonly serviceKey: string; ``` - *Type:* string Service key associated with your PagerDuty account. --- ##### `teamName`^Optional ```typescript public readonly teamName: string; ``` - *Type:* string Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration. --- ##### `tlsPemPath`^Optional ```typescript public readonly tlsPemPath: string; ``` - *Type:* string Root-relative path to the Transport Layer Security (TLS) Privacy Enhanced Mail (PEM) key and certificate file on the host. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string Endpoint web address to which MongoDB Cloud sends notifications. --- ##### `userName`^Optional ```typescript public readonly userName: string; ``` - *Type:* string Human-readable label that identifies your Prometheus incoming webhook. --- ### CfnTriggerProps View and manage your application's triggers: https://www.mongodb.com/docs/atlas/app-services/triggers/. #### Initializer ```typescript import { CfnTriggerProps } from 'awscdk-resources-mongodbatlas' const cfnTriggerProps: CfnTriggerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appId | string | App Services Application ID. | | name | string | The trigger's name. | | projectId | string | Project Id for application services. | | type | string | The trigger's type. | | authTrigger | AuthConfig | *No description.* | | databaseTrigger | DatabaseConfig | *No description.* | | disabled | boolean | If `true`, the trigger is disabled and does not listen for events or execute. | | eventProcessors | Event | An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. | | functionId | string | The ID of the function that the trigger calls when it fires. | | functionName | string | The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. | | profile | string | The profile is defined in AWS Secret manager. | | scheduleTrigger | ScheduleConfig | *No description.* | --- ##### `appId`^Required ```typescript public readonly appId: string; ``` - *Type:* string App Services Application ID. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The trigger's name. --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Project Id for application services. --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string The trigger's type. --- ##### `authTrigger`^Optional ```typescript public readonly authTrigger: AuthConfig; ``` - *Type:* AuthConfig --- ##### `databaseTrigger`^Optional ```typescript public readonly databaseTrigger: DatabaseConfig; ``` - *Type:* DatabaseConfig --- ##### `disabled`^Optional ```typescript public readonly disabled: boolean; ``` - *Type:* boolean If `true`, the trigger is disabled and does not listen for events or execute. --- ##### `eventProcessors`^Optional ```typescript public readonly eventProcessors: Event; ``` - *Type:* Event An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see [Send Trigger Events to AWS EventBridge](https://www.mongodb.com/docs/atlas/app-services/triggers/aws-eventbridge/#std-label-event_processor_example). --- ##### `functionId`^Optional ```typescript public readonly functionId: string; ``` - *Type:* string The ID of the function that the trigger calls when it fires. This value is the same as `event_processors.FUNCTION.function_id`. You can either define the value here or in `event_processors.FUNCTION.function_id`. The App Services backend duplicates the value to the configuration location where you did not define it. For example, if you define `function_id`, the backend duplicates it to `event_processors.FUNCTION.function_id`. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. This value is the same as `event_processors.FUNCTION.function_name`. You can either define the value here or in `event_processors.FUNCTION.function_name`. The App Services backend duplicates the value to the configuration location where you did not define it. For example, if you define `function_name`, the backend duplicates it to `event_processors.FUNCTION.function_name`. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- ##### `scheduleTrigger`^Optional ```typescript public readonly scheduleTrigger: ScheduleConfig; ``` - *Type:* ScheduleConfig --- ### CfnX509AuthenticationDatabaseUserProps Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List. To get MongoDB Cloud to generate a managed certificate for a database user, set `"x509Type" : "MANAGED"` on the desired MongoDB Database User. If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. #### Initializer ```typescript import { CfnX509AuthenticationDatabaseUserProps } from 'awscdk-resources-mongodbatlas' const cfnX509AuthenticationDatabaseUserProps: CfnX509AuthenticationDatabaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customerX509 | CustomerX509 | CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | | projectId | string | The unique identifier for the project . | | userName | string | Username of the database user to create a certificate for. | --- ##### `customerX509`^Optional ```typescript public readonly customerX509: CustomerX509; ``` - *Type:* CustomerX509 CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string The unique identifier for the project . --- ##### `userName`^Optional ```typescript public readonly userName: string; ``` - *Type:* string Username of the database user to create a certificate for. --- ### CloudProviderConfig Cloud provider linked to this Atlas Data Federation. #### Initializer ```typescript import { CloudProviderConfig } from 'awscdk-resources-mongodbatlas' const cloudProviderConfig: CloudProviderConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | externalId | string | Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. | | iamAssumedRoleArn | string | Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores. | | iamUserArn | string | Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores. | | roleId | string | Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. | | testS3Bucket | string | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | --- ##### `externalId`^Optional ```typescript public readonly externalId: string; ``` - *Type:* string Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. --- ##### `iamAssumedRoleArn`^Optional ```typescript public readonly iamAssumedRoleArn: string; ``` - *Type:* string Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores. --- ##### `iamUserArn`^Optional ```typescript public readonly iamUserArn: string; ``` - *Type:* string Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores. --- ##### `roleId`^Optional ```typescript public readonly roleId: string; ``` - *Type:* string Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. --- ##### `testS3Bucket`^Optional ```typescript public readonly testS3Bucket: string; ``` - *Type:* string Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. --- ### ClusterProps #### Initializer ```typescript import { ClusterProps } from 'awscdk-resources-mongodbatlas' const clusterProps: ClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | advancedSettings | ProcessArgs | *No description.* | | backupEnabled | boolean | *No description.* | | biConnector | CfnClusterPropsBiConnector | *No description.* | | clusterType | string | *No description.* | | connectionStrings | ConnectionStrings | *No description.* | | diskSizeGb | number | *No description.* | | encryptionAtRestProvider | CfnClusterPropsEncryptionAtRestProvider | *No description.* | | labels | CfnClusterPropsLabels[] | *No description.* | | mongoDbMajorVersion | string | *No description.* | | name | string | *No description.* | | paused | boolean | *No description.* | | pitEnabled | boolean | *No description.* | | projectId | string | *No description.* | | replicationSpecs | AdvancedReplicationSpec[] | *No description.* | | rootCertType | string | *No description.* | | terminationProtectionEnabled | boolean | *No description.* | | versionReleaseSystem | string | *No description.* | --- ##### `advancedSettings`^Optional ```typescript public readonly advancedSettings: ProcessArgs; ``` - *Type:* ProcessArgs --- ##### `backupEnabled`^Optional ```typescript public readonly backupEnabled: boolean; ``` - *Type:* boolean --- ##### `biConnector`^Optional ```typescript public readonly biConnector: CfnClusterPropsBiConnector; ``` - *Type:* CfnClusterPropsBiConnector --- ##### `clusterType`^Optional ```typescript public readonly clusterType: string; ``` - *Type:* string --- ##### `connectionStrings`^Optional ```typescript public readonly connectionStrings: ConnectionStrings; ``` - *Type:* ConnectionStrings - *Default:* REPLICASET --- ##### `diskSizeGb`^Optional ```typescript public readonly diskSizeGb: number; ``` - *Type:* number --- ##### `encryptionAtRestProvider`^Optional ```typescript public readonly encryptionAtRestProvider: CfnClusterPropsEncryptionAtRestProvider; ``` - *Type:* CfnClusterPropsEncryptionAtRestProvider --- ##### `labels`^Optional ```typescript public readonly labels: CfnClusterPropsLabels[]; ``` - *Type:* CfnClusterPropsLabels[] --- ##### `mongoDbMajorVersion`^Optional ```typescript public readonly mongoDbMajorVersion: string; ``` - *Type:* string --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `paused`^Optional ```typescript public readonly paused: boolean; ``` - *Type:* boolean - *Default:* auto-generated --- ##### `pitEnabled`^Optional ```typescript public readonly pitEnabled: boolean; ``` - *Type:* boolean --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string --- ##### `replicationSpecs`^Optional ```typescript public readonly replicationSpecs: AdvancedReplicationSpec[]; ``` - *Type:* AdvancedReplicationSpec[] --- ##### `rootCertType`^Optional ```typescript public readonly rootCertType: string; ``` - *Type:* string --- ##### `terminationProtectionEnabled`^Optional ```typescript public readonly terminationProtectionEnabled: boolean; ``` - *Type:* boolean --- ##### `versionReleaseSystem`^Optional ```typescript public readonly versionReleaseSystem: string; ``` - *Type:* string --- ### Collection Array of collections and data sources that map to a stores data store. #### Initializer ```typescript import { Collection } from 'awscdk-resources-mongodbatlas' const collection: Collection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataSources | DataSource[] | Array that contains the data stores that map to a collection for this Atlas Data Federation. | | name | string | *No description.* | --- ##### `dataSources`^Optional ```typescript public readonly dataSources: DataSource[]; ``` - *Type:* DataSource[] Array that contains the data stores that map to a collection for this Atlas Data Federation. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ### Compute Automatic Compute Scaling. #### Initializer ```typescript import { Compute } from 'awscdk-resources-mongodbatlas' const compute: Compute = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Flag that indicates whether someone enabled instance size auto-scaling. | | maxInstanceSize | string | Maximum instance size to which your cluster can automatically scale. | | minInstanceSize | string | Minimum instance size to which your cluster can automatically scale. | | scaleDownEnabled | boolean | Flag that indicates whether the instance size may scale down. | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether someone enabled instance size auto-scaling. Set to true to enable instance size auto-scaling. If enabled, you must specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize. Set to false to disable instance size automatic scaling. --- ##### `maxInstanceSize`^Optional ```typescript public readonly maxInstanceSize: string; ``` - *Type:* string Maximum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. --- ##### `minInstanceSize`^Optional ```typescript public readonly minInstanceSize: string; ``` - *Type:* string Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. --- ##### `scaleDownEnabled`^Optional ```typescript public readonly scaleDownEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. If you enable this option, specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize. --- ### ConnectionStrings Collection of Uniform Resource Locators that point to the MongoDB database. #### Initializer ```typescript import { ConnectionStrings } from 'awscdk-resources-mongodbatlas' const connectionStrings: ConnectionStrings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | standard | string | Public connection string that you can use to connect to this cluster. | | standardSrv | string | Public connection string that you can use to connect to this flex cluster. | --- ##### `standard`^Optional ```typescript public readonly standard: string; ``` - *Type:* string Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol. --- ##### `standardSrv`^Optional ```typescript public readonly standardSrv: string; ``` - *Type:* string Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol. --- ### CriteriaView #### Initializer ```typescript import { CriteriaView } from 'awscdk-resources-mongodbatlas' const criteriaView: CriteriaView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dateField | string | Indexed database parameter that stores the date that determines when data moves to the online archive. | | dateFormat | CriteriaViewDateFormat | Syntax used to write the date after which data moves to the online archive. | | expireAfterDays | number | Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". | | query | string | MongoDB find query that selects documents to archive. | | type | CriteriaViewType | Means by which MongoDB Cloud selects data to archive. | --- ##### `dateField`^Optional ```typescript public readonly dateField: string; ``` - *Type:* string Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when you set "criteria.type" : "DATE". --- ##### `dateFormat`^Optional ```typescript public readonly dateFormat: CriteriaViewDateFormat; ``` - *Type:* CriteriaViewDateFormat Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES". --- ##### `expireAfterDays`^Optional ```typescript public readonly expireAfterDays: number; ``` - *Type:* number Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". --- ##### `query`^Optional ```typescript public readonly query: string; ``` - *Type:* string MongoDB find query that selects documents to archive. The specified query follows the syntax of the db.collection.find(query) command. This query can't use the empty document ({}) to return all documents. Set this parameter when "criteria.type" : "CUSTOM". --- ##### `type`^Optional ```typescript public readonly type: CriteriaViewType; ``` - *Type:* CriteriaViewType Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. (if DATE is selected, the PartitionFields.FieldName must be completed with the Criteria.DateField value)**CUSTOM** selects documents to archive based on a custom JSON query (When selecting this option, the Query property must be inputted). MongoDB Cloud doesn't support **CUSTOM** when `collectionType: TIMESERIES`. --- ### CustomerX509 #### Initializer ```typescript import { CustomerX509 } from 'awscdk-resources-mongodbatlas' const customerX509: CustomerX509 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cas | string | PEM string containing one or more customer CAs for database user authentication. | --- ##### `cas`^Optional ```typescript public readonly cas: string; ``` - *Type:* string PEM string containing one or more customer CAs for database user authentication. --- ### Database #### Initializer ```typescript import { Database } from 'awscdk-resources-mongodbatlas' const database: Database = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collections | Collection[] | Array of collections and data sources that map to a stores data store. | | maxWildcardCollections | string | Maximum number of wildcard collections in the database. | | name | string | Human-readable label that identifies the database to which the Atlas Data Federation maps data. | | views | View[] | Array of aggregation pipelines that apply to the collection. | --- ##### `collections`^Optional ```typescript public readonly collections: Collection[]; ``` - *Type:* Collection[] Array of collections and data sources that map to a stores data store. --- ##### `maxWildcardCollections`^Optional ```typescript public readonly maxWildcardCollections: string; ``` - *Type:* string Maximum number of wildcard collections in the database. This only applies to S3 data sources. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the database to which the Atlas Data Federation maps data. --- ##### `views`^Optional ```typescript public readonly views: View[]; ``` - *Type:* View[] Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources. --- ### DatabaseConfig #### Initializer ```typescript import { DatabaseConfig } from 'awscdk-resources-mongodbatlas' const databaseConfig: DatabaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collection | string | The name of a collection in the specified database. | | database | string | The name of a database in the linked data source. | | fullDocument | boolean | If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. | | fullDocumentBeforeChange | boolean | If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. | | match | string | stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. | | maximumThroughput | boolean | If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). | | operationTypes | DatabaseConfigOperationTypes[] | The type(s) of MongoDB change event that the trigger listens for. | | project | string | stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. | | serviceId | string | The _id value of a linked MongoDB data source. | | skipCatchupEvents | boolean | If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. | | tolerateResumeErrors | boolean | If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. | | unordered | boolean | If `true`, event ordering is disabled and this Trigger can process events in parallel. | --- ##### `collection`^Optional ```typescript public readonly collection: string; ``` - *Type:* string The name of a collection in the specified database. The trigger listens to events from this collection. --- ##### `database`^Optional ```typescript public readonly database: string; ``` - *Type:* string The name of a database in the linked data source. --- ##### `fullDocument`^Optional ```typescript public readonly fullDocument: boolean; ``` - *Type:* boolean If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. --- ##### `fullDocumentBeforeChange`^Optional ```typescript public readonly fullDocumentBeforeChange: boolean; ``` - *Type:* boolean If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. You must enable [document preimages](https://www.mongodb.com/docs/atlas/app-services/mongodb/preimages/) for your cluster to include these snapshots. --- ##### `match`^Optional ```typescript public readonly match: string; ``` - *Type:* string stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. --- ##### `maximumThroughput`^Optional ```typescript public readonly maximumThroughput: boolean; ``` - *Type:* boolean If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). --- ##### `operationTypes`^Optional ```typescript public readonly operationTypes: DatabaseConfigOperationTypes[]; ``` - *Type:* DatabaseConfigOperationTypes[] The type(s) of MongoDB change event that the trigger listens for. --- ##### `project`^Optional ```typescript public readonly project: string; ``` - *Type:* string stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. --- ##### `serviceId`^Optional ```typescript public readonly serviceId: string; ``` - *Type:* string The _id value of a linked MongoDB data source. See [Get a Data Source](#operation/adminGetService). --- ##### `skipCatchupEvents`^Optional ```typescript public readonly skipCatchupEvents: boolean; ``` - *Type:* boolean If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. --- ##### `tolerateResumeErrors`^Optional ```typescript public readonly tolerateResumeErrors: boolean; ``` - *Type:* boolean If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. All change stream events from when the Trigger was suspended until the Trigger resumes execution do not have the Trigger fire for them. --- ##### `unordered`^Optional ```typescript public readonly unordered: boolean; ``` - *Type:* boolean If `true`, event ordering is disabled and this Trigger can process events in parallel. If `false`, event ordering is enabled and the Trigger executes events serially. --- ### DatabaseUserProps #### Initializer ```typescript import { DatabaseUserProps } from 'awscdk-resources-mongodbatlas' const databaseUserProps: DatabaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsiamType | CfnDatabaseUserPropsAwsiamType | *No description.* | | databaseName | string | *No description.* | | deleteAfterDate | string | *No description.* | | labels | LabelDefinition[] | *No description.* | | ldapAuthType | CfnDatabaseUserPropsLdapAuthType | *No description.* | | password | string | *No description.* | | projectId | string | *No description.* | | roles | RoleDefinition[] | *No description.* | | scopes | ScopeDefinition[] | *No description.* | | username | string | *No description.* | | x509Type | CfnDatabaseUserPropsX509Type | *No description.* | --- ##### `awsiamType`^Optional ```typescript public readonly awsiamType: CfnDatabaseUserPropsAwsiamType; ``` - *Type:* CfnDatabaseUserPropsAwsiamType --- ##### `databaseName`^Optional ```typescript public readonly databaseName: string; ``` - *Type:* string --- ##### `deleteAfterDate`^Optional ```typescript public readonly deleteAfterDate: string; ``` - *Type:* string --- ##### `labels`^Optional ```typescript public readonly labels: LabelDefinition[]; ``` - *Type:* LabelDefinition[] - *Default:* admin --- ##### `ldapAuthType`^Optional ```typescript public readonly ldapAuthType: CfnDatabaseUserPropsLdapAuthType; ``` - *Type:* CfnDatabaseUserPropsLdapAuthType --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string - *Default:* cdk-pwd --- ##### `roles`^Optional ```typescript public readonly roles: RoleDefinition[]; ``` - *Type:* RoleDefinition[] --- ##### `scopes`^Optional ```typescript public readonly scopes: ScopeDefinition[]; ``` - *Type:* ScopeDefinition[] --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string - *Default:* cdk-user --- ##### `x509Type`^Optional ```typescript public readonly x509Type: CfnDatabaseUserPropsX509Type; ``` - *Type:* CfnDatabaseUserPropsX509Type --- ### DatadogIntegrationProps #### Initializer ```typescript import { DatadogIntegrationProps } from 'awscdk-resources-mongodbatlas' const datadogIntegrationProps: DatadogIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Atlas API keys. | | apiKey | string | Key that allows MongoDB Cloud to access your Datadog account. | | region | DatadogRegion | Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. | | sendUserProvidedResourceTags | boolean | Flag that indicates whether to include user-defined resource tags when sending metrics and alerts to Datadog. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Atlas API keys. --- ##### `apiKey`^Required ```typescript public readonly apiKey: string; ``` - *Type:* string Key that allows MongoDB Cloud to access your Datadog account. --- ##### `region`^Required ```typescript public readonly region: DatadogRegion; ``` - *Type:* DatadogRegion Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. --- ##### `sendUserProvidedResourceTags`^Optional ```typescript public readonly sendUserProvidedResourceTags: boolean; ``` - *Type:* boolean Flag that indicates whether to include user-defined resource tags when sending metrics and alerts to Datadog. --- ### DataProcessRegion Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. #### Initializer ```typescript import { DataProcessRegion } from 'awscdk-resources-mongodbatlas' const dataProcessRegion: DataProcessRegion = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | region | string | Name of the region to which the Atlas Data Federation routes client connections. | | cloudProvider | string | Name of the cloud service that hosts the Atlas Data Federation data stores. | --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string Name of the region to which the Atlas Data Federation routes client connections. --- ##### `cloudProvider`^Optional ```typescript public readonly cloudProvider: string; ``` - *Type:* string Name of the cloud service that hosts the Atlas Data Federation data stores. --- ### DataSource #### Initializer ```typescript import { DataSource } from 'awscdk-resources-mongodbatlas' const dataSource: DataSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowInsecure | boolean | Flag that validates the scheme in the specified URLs. | | collection | string | Human-readable label that identifies the collection in the database. | | collectionRegex | string | Regex pattern to use for creating the wildcard (*) collection. | | database | string | Human-readable label that identifies the database, which contains the collection in the cluster. | | databaseRegex | string | Regex pattern to use for creating the wildcard (*) collection. | | defaultFormat | string | File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.Enum: ".avro" ".avro.bz2" ".avro.gz" ".bson" ".bson.bz2" ".bson.gz" ".bsonx" ".csv" ".csv.bz2" ".csv.gz" ".json" ".json.bz2" ".json.gz" ".orc" ".parquet" ".tsv" ".tsv.bz2" ".tsv.gz". | | path | string | File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.Specify / to capture all files and folders from the prefix path. | | provenanceFieldName | string | Name for the field that includes the provenance of the documents in the results. | | storeName | string | Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. | | urls | string[] | URLs of the publicly accessible data files. | --- ##### `allowInsecure`^Optional ```typescript public readonly allowInsecure: boolean; ``` - *Type:* boolean Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only. --- ##### `collection`^Optional ```typescript public readonly collection: string; ``` - *Type:* string Human-readable label that identifies the collection in the database. For creating a wildcard (*) collection, you must omit this parameter. --- ##### `collectionRegex`^Optional ```typescript public readonly collectionRegex: string; ``` - *Type:* string Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ). --- ##### `database`^Optional ```typescript public readonly database: string; ``` - *Type:* string Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (*) collections for dynamically generated databases. --- ##### `databaseRegex`^Optional ```typescript public readonly databaseRegex: string; ``` - *Type:* string Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ). --- ##### `defaultFormat`^Optional ```typescript public readonly defaultFormat: string; ``` - *Type:* string File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.Enum: ".avro" ".avro.bz2" ".avro.gz" ".bson" ".bson.bz2" ".bson.gz" ".bsonx" ".csv" ".csv.bz2" ".csv.gz" ".json" ".json.bz2" ".json.gz" ".orc" ".parquet" ".tsv" ".tsv.bz2" ".tsv.gz". --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.Specify / to capture all files and folders from the prefix path. --- ##### `provenanceFieldName`^Optional ```typescript public readonly provenanceFieldName: string; ``` - *Type:* string Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider. --- ##### `storeName`^Optional ```typescript public readonly storeName: string; ``` - *Type:* string Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. --- ##### `urls`^Optional ```typescript public readonly urls: string[]; ``` - *Type:* string[] URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Federation creates a partition for each URL. If empty or omitted, Data Federation uses the URLs from the store specified in the dataSources.storeName parameter. --- ### DbRoleToExecute The name of a Built in or Custom DB Role to connect to an Atlas Cluster. #### Initializer ```typescript import { DbRoleToExecute } from 'awscdk-resources-mongodbatlas' const dbRoleToExecute: DbRoleToExecute = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | role | string | The name of the role to use. | | type | DbRoleToExecuteType | Type of the DB role. | --- ##### `role`^Optional ```typescript public readonly role: string; ``` - *Type:* string The name of the role to use. Can be a built in role or a custom role. --- ##### `type`^Optional ```typescript public readonly type: DbRoleToExecuteType; ``` - *Type:* DbRoleToExecuteType Type of the DB role. Can be either BuiltIn or Custom. --- ### DiskGb Automatic cluster storage settings that apply to this cluster. #### Initializer ```typescript import { DiskGb } from 'awscdk-resources-mongodbatlas' const diskGb: DiskGb = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Flag that indicates whether this cluster enables disk auto-scaling. | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling. --- ### EncryptionAtRestProps #### Initializer ```typescript import { EncryptionAtRestProps } from 'awscdk-resources-mongodbatlas' const encryptionAtRestProps: EncryptionAtRestProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customerMasterKeyId | string | The AWS customer master key used to encrypt and decrypt the MongoDB master keys. | | roleId | string | ID of an AWS IAM role authorized to manage an AWS customer master key. | | enabledEncryptionAtRest | boolean | Specifies whether Encryption at Rest is enabled for an Atlas project. | | region | string | The AWS region in which the AWS customer master key exists. | --- ##### `customerMasterKeyId`^Required ```typescript public readonly customerMasterKeyId: string; ``` - *Type:* string The AWS customer master key used to encrypt and decrypt the MongoDB master keys. --- ##### `roleId`^Required ```typescript public readonly roleId: string; ``` - *Type:* string ID of an AWS IAM role authorized to manage an AWS customer master key. --- ##### `enabledEncryptionAtRest`^Optional ```typescript public readonly enabledEncryptionAtRest: boolean; ``` - *Type:* 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. Default Value: true --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string The AWS region in which the AWS customer master key exists. --- ### Event #### Initializer ```typescript import { Event } from 'awscdk-resources-mongodbatlas' const event: Event = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awseventbridge | EventAwseventbridge | *No description.* | | function | EventFunction | *No description.* | --- ##### `awseventbridge`^Optional ```typescript public readonly awseventbridge: EventAwseventbridge; ``` - *Type:* EventAwseventbridge --- ##### `function`^Optional ```typescript public readonly function: EventFunction; ``` - *Type:* EventFunction --- ### EventAwseventbridge #### Initializer ```typescript import { EventAwseventbridge } from 'awscdk-resources-mongodbatlas' const eventAwseventbridge: EventAwseventbridge = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsConfig | EventAwseventbridgeAwsConfig | *No description.* | --- ##### `awsConfig`^Optional ```typescript public readonly awsConfig: EventAwseventbridgeAwsConfig; ``` - *Type:* EventAwseventbridgeAwsConfig --- ### EventAwseventbridgeAwsConfig #### Initializer ```typescript import { EventAwseventbridgeAwsConfig } from 'awscdk-resources-mongodbatlas' const eventAwseventbridgeAwsConfig: EventAwseventbridgeAwsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accountId | string | An AWS Account ID. | | extendedJsonEnabled | boolean | If `true`, event objects are serialized using EJSON. | | region | string | An AWS region. | --- ##### `accountId`^Optional ```typescript public readonly accountId: string; ``` - *Type:* string An AWS Account ID. --- ##### `extendedJsonEnabled`^Optional ```typescript public readonly extendedJsonEnabled: boolean; ``` - *Type:* boolean If `true`, event objects are serialized using EJSON. --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string An AWS region. --- ### EventFunction #### Initializer ```typescript import { EventFunction } from 'awscdk-resources-mongodbatlas' const eventFunction: EventFunction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | funcConfig | EventFunctionFuncConfig | *No description.* | --- ##### `funcConfig`^Optional ```typescript public readonly funcConfig: EventFunctionFuncConfig; ``` - *Type:* EventFunctionFuncConfig --- ### EventFunctionFuncConfig #### Initializer ```typescript import { EventFunctionFuncConfig } from 'awscdk-resources-mongodbatlas' const eventFunctionFuncConfig: EventFunctionFuncConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | functionId | string | The ID of the function that the trigger calls when it fires. | | functionName | string | The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. | --- ##### `functionId`^Optional ```typescript public readonly functionId: string; ``` - *Type:* string The ID of the function that the trigger calls when it fires. This value is the same as the root-level `function_id`. You can either define the value here or in `function_id`. The App Services backend duplicates the value to the configuration location where you did not define it. For example, if you define `event_processors.FUNCTION.function_id`, the backend duplicates it to `function_id`. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. This value is the same as the root-level `function_name`. You can either define the value here or in `function_name`. The App Services backend duplicates the value to the configuration location where you did not define it. For example, if you define `event_processors.FUNCTION.function_name`, the backend duplicates it to `function_name`. --- ### Export #### Initializer ```typescript import { Export } from 'awscdk-resources-mongodbatlas' const export: Export = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exportBucketId | string | Unique identifier of the AWS bucket to export the cloud backup snapshot to. | | frequencyType | string | Frequency associated with the export policy. | --- ##### `exportBucketId`^Optional ```typescript public readonly exportBucketId: string; ``` - *Type:* string Unique identifier of the AWS bucket to export the cloud backup snapshot to. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: string; ``` - *Type:* string Frequency associated with the export policy. Value can be daily, weekly, monthly or yearly. --- ### Filter #### Initializer ```typescript import { Filter } from 'awscdk-resources-mongodbatlas' const filter: Filter = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | FilterCloudProvider | *No description.* | | region | string | *No description.* | | type | string | *No description.* | --- ##### `cloudProvider`^Optional ```typescript public readonly cloudProvider: FilterCloudProvider; ``` - *Type:* FilterCloudProvider --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string --- ### InheritedRole #### Initializer ```typescript import { InheritedRole } from 'awscdk-resources-mongodbatlas' const inheritedRole: InheritedRole = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | db | string | *No description.* | | role | string | *No description.* | --- ##### `db`^Optional ```typescript public readonly db: string; ``` - *Type:* string --- ##### `role`^Optional ```typescript public readonly role: string; ``` - *Type:* string --- ### IntegerThresholdView #### Initializer ```typescript import { IntegerThresholdView } from 'awscdk-resources-mongodbatlas' const integerThresholdView: IntegerThresholdView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metricName | string | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured threshold. | | mode | string | Indicates how MongoDB Cloud computes the current metric value (e.g., AVERAGE). | | operator | IntegerThresholdViewOperator | Comparison operator to apply when checking the current metric value. | | threshold | number | Value of metric that, when exceeded, triggers an alert. | | units | string | Element used to express the quantity. | --- ##### `metricName`^Optional ```typescript public readonly metricName: string; ``` - *Type:* string Human-readable label that identifies the metric against which MongoDB Cloud checks the configured threshold. --- ##### `mode`^Optional ```typescript public readonly mode: string; ``` - *Type:* string Indicates how MongoDB Cloud computes the current metric value (e.g., AVERAGE). --- ##### `operator`^Optional ```typescript public readonly operator: IntegerThresholdViewOperator; ``` - *Type:* IntegerThresholdViewOperator Comparison operator to apply when checking the current metric value. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number Value of metric that, when exceeded, triggers an alert. --- ##### `units`^Optional ```typescript public readonly units: string; ``` - *Type:* string Element used to express the quantity. This can be an element of time, storage capacity, and the like. --- ### IpAccessListProps #### Initializer ```typescript import { IpAccessListProps } from 'awscdk-resources-mongodbatlas' const ipAccessListProps: IpAccessListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessList | AccessListDefinition[] | *No description.* | | listOptions | ListOptions | *No description.* | | projectId | string | *No description.* | | totalCount | number | *No description.* | --- ##### `accessList`^Required ```typescript public readonly accessList: AccessListDefinition[]; ``` - *Type:* AccessListDefinition[] --- ##### `listOptions`^Optional ```typescript public readonly listOptions: ListOptions; ``` - *Type:* ListOptions --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string - *Default:* allow-all --- ##### `totalCount`^Optional ```typescript public readonly totalCount: number; ``` - *Type:* number --- ### LabelDefinition #### Initializer ```typescript import { LabelDefinition } from 'awscdk-resources-mongodbatlas' const labelDefinition: LabelDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | *No description.* | | value | string | *No description.* | --- ##### `key`^Optional ```typescript public readonly key: string; ``` - *Type:* string --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string --- ### Link #### Initializer ```typescript import { Link } from 'awscdk-resources-mongodbatlas' const link: Link = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | href | string | Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. | | rel | string | Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. | --- ##### `href`^Optional ```typescript public readonly href: string; ``` - *Type:* string Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://mms.mongodb.com`. --- ##### `rel`^Optional ```typescript public readonly rel: string; ``` - *Type:* string Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://mms.mongodb.com`. --- ### ListOptions #### Initializer ```typescript import { ListOptions } from 'awscdk-resources-mongodbatlas' const listOptions: ListOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | includeCount | boolean | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | | itemsPerPage | number | Number of items that the response returns per page. | | pageNum | number | Number of the page that displays the current set of the total objects that the response returns. | --- ##### `includeCount`^Optional ```typescript public readonly includeCount: boolean; ``` - *Type:* boolean Flag that indicates whether the response returns the total number of items (totalCount) in the response. --- ##### `itemsPerPage`^Optional ```typescript public readonly itemsPerPage: number; ``` - *Type:* number Number of items that the response returns per page. --- ##### `pageNum`^Optional ```typescript public readonly pageNum: number; ``` - *Type:* number Number of the page that displays the current set of the total objects that the response returns. --- ### ManagedNamespace #### Initializer ```typescript import { ManagedNamespace } from 'awscdk-resources-mongodbatlas' const managedNamespace: ManagedNamespace = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collection | string | Human-readable label of the collection to manage for this Global Cluster. | | customShardKey | string | Database parameter used to divide the *collection* into shards. | | db | string | Human-readable label of the database to manage for this Global Cluster. | | isCustomShardKeyHashed | boolean | Flag that indicates whether someone hashed the custom shard key for the specified collection. | | isShardKeyUnique | boolean | Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/). | --- ##### `collection`^Optional ```typescript public readonly collection: string; ``` - *Type:* string Human-readable label of the collection to manage for this Global Cluster. --- ##### `customShardKey`^Optional ```typescript public readonly customShardKey: string; ``` - *Type:* string Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key. --- ##### `db`^Optional ```typescript public readonly db: string; ``` - *Type:* string Human-readable label of the database to manage for this Global Cluster. --- ##### `isCustomShardKeyHashed`^Optional ```typescript public readonly isCustomShardKeyHashed: boolean; ``` - *Type:* boolean Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding. --- ##### `isShardKeyUnique`^Optional ```typescript public readonly isShardKeyUnique: boolean; ``` - *Type:* boolean Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/). --- ### Matcher #### Initializer ```typescript import { Matcher } from 'awscdk-resources-mongodbatlas' const matcher: Matcher = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fieldName | MatcherFieldName | Name of the parameter in the target object that MongoDB Cloud checks. | | operator | MatcherOperator | Comparison operator to apply when checking the current metric value against **matcher[n].value**. | | value | string | Value to match or exceed using the specified **matchers.operator**. | --- ##### `fieldName`^Optional ```typescript public readonly fieldName: MatcherFieldName; ``` - *Type:* MatcherFieldName Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. --- ##### `operator`^Optional ```typescript public readonly operator: MatcherOperator; ``` - *Type:* MatcherOperator Comparison operator to apply when checking the current metric value against **matcher[n].value**. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string Value to match or exceed using the specified **matchers.operator**. --- ### MetricThresholdView #### Initializer ```typescript import { MetricThresholdView } from 'awscdk-resources-mongodbatlas' const metricThresholdView: MetricThresholdView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metricName | string | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | | mode | MetricThresholdViewMode | MongoDB Cloud computes the current metric value as an average. | | operator | MetricThresholdViewOperator | Comparison operator to apply when checking the current metric value. | | threshold | number | Value of metric that, when exceeded, triggers an alert. | | units | string | Element used to express the quantity. | --- ##### `metricName`^Optional ```typescript public readonly metricName: string; ``` - *Type:* string Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. --- ##### `mode`^Optional ```typescript public readonly mode: MetricThresholdViewMode; ``` - *Type:* MetricThresholdViewMode MongoDB Cloud computes the current metric value as an average. --- ##### `operator`^Optional ```typescript public readonly operator: MetricThresholdViewOperator; ``` - *Type:* MetricThresholdViewOperator Comparison operator to apply when checking the current metric value. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number Value of metric that, when exceeded, triggers an alert. --- ##### `units`^Optional ```typescript public readonly units: string; ``` - *Type:* string Element used to express the quantity. This can be an element of time, storage capacity, and the like. --- ### MicrosoftTeamsIntegrationProps #### Initializer ```typescript import { MicrosoftTeamsIntegrationProps } from 'awscdk-resources-mongodbatlas' const microsoftTeamsIntegrationProps: MicrosoftTeamsIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Atlas API keys. | | microsoftTeamsWebhookUrl | string | Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Atlas API keys. --- ##### `microsoftTeamsWebhookUrl`^Required ```typescript public readonly microsoftTeamsWebhookUrl: string; ``` - *Type:* string Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. --- ### Networking Networking configuration for connections. #### Initializer ```typescript import { Networking } from 'awscdk-resources-mongodbatlas' const networking: Networking = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | access | NetworkingAccess | Network access configuration. | --- ##### `access`^Required ```typescript public readonly access: NetworkingAccess; ``` - *Type:* NetworkingAccess Network access configuration. --- ### NetworkingAccess Network access configuration. #### Initializer ```typescript import { NetworkingAccess } from 'awscdk-resources-mongodbatlas' const networkingAccess: NetworkingAccess = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionId | string | Unique identifier of the connection. | | name | string | Reserved. | | tgwRouteId | string | Reserved. | | type | string | Type of network access. | --- ##### `connectionId`^Optional ```typescript public readonly connectionId: string; ``` - *Type:* string Unique identifier of the connection. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Reserved. Will be used by PRIVATE_LINK connection type. --- ##### `tgwRouteId`^Optional ```typescript public readonly tgwRouteId: string; ``` - *Type:* string Reserved. Will be used by TRANSIT_GATEWAY connection type. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Type of network access. Can be PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. --- ### NotificationView #### Initializer ```typescript import { NotificationView } from 'awscdk-resources-mongodbatlas' const notificationView: NotificationView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiToken | string | Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. | | channelName | string | Name of the Slack channel to which MongoDB Cloud sends alert notifications. | | datadogApiKey | string | Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. | | datadogRegion | NotificationViewDatadogRegion | Datadog region that indicates which API Uniform Resource Locator (URL) to use. | | delayMin | number | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | | emailAddress | string | Email address to which MongoDB Cloud sends alert notifications. | | emailEnabled | boolean | Flag that indicates whether MongoDB Cloud should send email notifications. | | integrationId | string | Unique 24-hexadecimal digit string that identifies the third party integration to use for this alert configuration. | | intervalMin | number | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. | | microsoftTeamsWebhookUrl | string | Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. | | mobileNumber | string | Mobile phone number to which MongoDB Cloud sends alert notifications. | | notificationToken | string | HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. | | notifierId | string | Unique 24-hexadecimal digit string that identifies the notifier to use for this alert configuration. | | opsGenieApiKey | string | API Key that MongoDB Cloud needs to send this notification via Opsgenie. | | opsGenieRegion | NotificationViewOpsGenieRegion | Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. | | orgName | string | Flowdock organization name to which MongoDB Cloud sends alert notifications. | | roles | NotificationViewRoles[] | List that contains the one or more organization or project roles that receive the configured alert. | | roomName | string | HipChat API room name to which MongoDB Cloud sends alert notifications. | | serviceKey | string | PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. | | severity | NotificationViewSeverity | Degree of seriousness given to this notification. | | smsEnabled | boolean | Flag that indicates whether MongoDB Cloud should send text message notifications. | | teamId | string | Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. | | teamName | string | Name of the MongoDB Cloud team that receives this notification. | | typeName | NotificationViewTypeName | Human-readable label that displays the alert notification type. | | username | string | MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. | | victorOpsApiKey | string | API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. | | victorOpsRoutingKey | string | Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. | | webhookSecret | string | An optional field for your webhook secret. | | webhookUrl | string | Your webhook URL. | --- ##### `apiToken`^Optional ```typescript public readonly apiToken: string; ``` - *Type:* string Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when '"notifications.typeName" : "SLACK"'. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. --- ##### `channelName`^Optional ```typescript public readonly channelName: string; ``` - *Type:* string Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "SLACK"'. --- ##### `datadogApiKey`^Optional ```typescript public readonly datadogApiKey: string; ``` - *Type:* string Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when '"notifications.typeName" : "DATADOG"'. --- ##### `datadogRegion`^Optional ```typescript public readonly datadogRegion: NotificationViewDatadogRegion; ``` - *Type:* NotificationViewDatadogRegion Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when '"notifications.typeName" : "DATADOG"'. --- ##### `delayMin`^Optional ```typescript public readonly delayMin: number; ``` - *Type:* number Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. --- ##### `emailAddress`^Optional ```typescript public readonly emailAddress: string; ``` - *Type:* string Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "EMAIL"'. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users ('"notifications.typeName" : "USER"') - MongoDB Cloud users with specific project roles ('"notifications.typeName" : "GROUP"') - MongoDB Cloud users with specific organization roles ('"notifications.typeName" : "ORG"') - MongoDB Cloud teams ('"notifications.typeName" : "TEAM"') To send emails to one MongoDB Cloud user or grouping of users, set the **notifications.emailEnabled** parameter. --- ##### `emailEnabled`^Optional ```typescript public readonly emailEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - '"notifications.typeName" : "ORG"' - '"notifications.typeName" : "GROUP"' - '"notifications.typeName" : "USER"' --- ##### `integrationId`^Optional ```typescript public readonly integrationId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the third party integration to use for this alert configuration. --- ##### `intervalMin`^Optional ```typescript public readonly intervalMin: number; ``` - *Type:* number Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. --- ##### `microsoftTeamsWebhookUrl`^Optional ```typescript public readonly microsoftTeamsWebhookUrl: string; ``` - *Type:* string Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when '"notifications.typeName" : "MICROSOFT_TEAMS"'. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. --- ##### `mobileNumber`^Optional ```typescript public readonly mobileNumber: string; ``` - *Type:* string Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "SMS"'. --- ##### `notificationToken`^Optional ```typescript public readonly notificationToken: string; ``` - *Type:* string HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when '"notifications.typeName" : "HIP_CHAT"'". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it. --- ##### `notifierId`^Optional ```typescript public readonly notifierId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the notifier to use for this alert configuration. --- ##### `opsGenieApiKey`^Optional ```typescript public readonly opsGenieApiKey: string; ``` - *Type:* string API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when '"notifications.typeName" : "OPS_GENIE"'. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. --- ##### `opsGenieRegion`^Optional ```typescript public readonly opsGenieRegion: NotificationViewOpsGenieRegion; ``` - *Type:* NotificationViewOpsGenieRegion Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. --- ##### `orgName`^Optional ```typescript public readonly orgName: string; ``` - *Type:* string Flowdock organization name to which MongoDB Cloud sends alert notifications. This name appears after 'www.flowdock.com/app/' in the Uniform Resource Locator (URL) path. The resource requires this parameter when '"notifications.typeName" : "FLOWDOCK"'. --- ##### `roles`^Optional ```typescript public readonly roles: NotificationViewRoles[]; ``` - *Type:* NotificationViewRoles[] List that contains the one or more organization or project roles that receive the configured alert. The resource requires this parameter when '"notifications.typeName" : "GROUP"' or '"notifications.typeName" : "ORG"'. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role. --- ##### `roomName`^Optional ```typescript public readonly roomName: string; ``` - *Type:* string HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "HIP_CHAT"'". --- ##### `serviceKey`^Optional ```typescript public readonly serviceKey: string; ``` - *Type:* string PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when '"notifications.typeName" : "PAGER_DUTY"'. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. --- ##### `severity`^Optional ```typescript public readonly severity: NotificationViewSeverity; ``` - *Type:* NotificationViewSeverity Degree of seriousness given to this notification. --- ##### `smsEnabled`^Optional ```typescript public readonly smsEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - '"notifications.typeName" : "ORG"' - '"notifications.typeName" : "GROUP"' - '"notifications.typeName" : "USER"' --- ##### `teamId`^Optional ```typescript public readonly teamId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when '"notifications.typeName" : "TEAM"'. --- ##### `teamName`^Optional ```typescript public readonly teamName: string; ``` - *Type:* string Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when '"notifications.typeName" : "TEAM"'. --- ##### `typeName`^Optional ```typescript public readonly typeName: NotificationViewTypeName; ``` - *Type:* NotificationViewTypeName Human-readable label that displays the alert notification type. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when '"notifications.typeName" : "USER"'. --- ##### `victorOpsApiKey`^Optional ```typescript public readonly victorOpsApiKey: string; ``` - *Type:* string API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when '"notifications.typeName" : "VICTOR_OPS"'. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. --- ##### `victorOpsRoutingKey`^Optional ```typescript public readonly victorOpsRoutingKey: string; ``` - *Type:* string Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when '"notifications.typeName" : "VICTOR_OPS"'. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. --- ##### `webhookSecret`^Optional ```typescript public readonly webhookSecret: string; ``` - *Type:* string An optional field for your webhook secret. --- ##### `webhookUrl`^Optional ```typescript public readonly webhookUrl: string; ``` - *Type:* string Your webhook URL. --- ### OnDemandPolicyItem On-demand backup policy item configuration. When provided, FrequencyInterval, RetentionUnit, and RetentionValue are required. #### Initializer ```typescript import { OnDemandPolicyItem } from 'awscdk-resources-mongodbatlas' const onDemandPolicyItem: OnDemandPolicyItem = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | frequencyInterval | number | Number that indicates the frequency interval for a set of snapshots. | | frequencyType | string | Frequency associated with the backup policy item. | | id | string | Unique identifier of the backup policy item. | | retentionUnit | OnDemandPolicyItemRetentionUnit | Unit of time in which MongoDB Cloud measures snapshot retention. | | retentionValue | number | Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. | --- ##### `frequencyInterval`^Optional ```typescript public readonly frequencyInterval: number; ``` - *Type:* number Number that indicates the frequency interval for a set of snapshots. Required when OnDemandPolicyItem is provided. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: string; ``` - *Type:* string Frequency associated with the backup policy item. For on-demand policies, the frequency type is 'ondemand'. This is a read-only value. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the backup policy item. --- ##### `retentionUnit`^Optional ```typescript public readonly retentionUnit: OnDemandPolicyItemRetentionUnit; ``` - *Type:* OnDemandPolicyItemRetentionUnit Unit of time in which MongoDB Cloud measures snapshot retention. Required when OnDemandPolicyItem is provided. --- ##### `retentionValue`^Optional ```typescript public readonly retentionValue: number; ``` - *Type:* number Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. Required when OnDemandPolicyItem is provided. --- ### PagerDutyIntegrationProps #### Initializer ```typescript import { PagerDutyIntegrationProps } from 'awscdk-resources-mongodbatlas' const pagerDutyIntegrationProps: PagerDutyIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Atlas API keys. | | region | PagerDutyRegion | PagerDuty region that indicates the API Uniform Resource Locator (URL) to use. | | serviceKey | string | Service key associated with your PagerDuty account. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Atlas API keys. --- ##### `region`^Required ```typescript public readonly region: PagerDutyRegion; ``` - *Type:* PagerDutyRegion PagerDuty region that indicates the API Uniform Resource Locator (URL) to use. --- ##### `serviceKey`^Required ```typescript public readonly serviceKey: string; ``` - *Type:* string Service key associated with your PagerDuty account. --- ### PartitionFieldView #### Initializer ```typescript import { PartitionFieldView } from 'awscdk-resources-mongodbatlas' const partitionFieldView: PartitionFieldView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fieldName | string | Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. | | order | number | Sequence in which MongoDB Cloud slices the collection data to create partitions. | --- ##### `fieldName`^Optional ```typescript public readonly fieldName: string; ``` - *Type:* string Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation. --- ##### `order`^Optional ```typescript public readonly order: number; ``` - *Type:* number Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence. --- ### PrivateEndpoint #### Initializer ```typescript import { PrivateEndpoint } from 'awscdk-resources-mongodbatlas' const privateEndpoint: PrivateEndpoint = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | atlasPrivateEndpointStatus | string | Status of the Atlas PrivateEndpoint connection. | | awsPrivateEndpointStatus | string | Status of the AWS PrivateEndpoint connection. | | interfaceEndpointId | string | Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. | | subnetIds | string[] | List of string representing the AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint). | | vpcId | string | String Representing the AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint). | --- ##### `atlasPrivateEndpointStatus`^Optional ```typescript public readonly atlasPrivateEndpointStatus: string; ``` - *Type:* string Status of the Atlas PrivateEndpoint connection. --- ##### `awsPrivateEndpointStatus`^Optional ```typescript public readonly awsPrivateEndpointStatus: string; ``` - *Type:* string Status of the AWS PrivateEndpoint connection. --- ##### `interfaceEndpointId`^Optional ```typescript public readonly interfaceEndpointId: string; ``` - *Type:* string Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. --- ##### `subnetIds`^Optional ```typescript public readonly subnetIds: string[]; ``` - *Type:* string[] List of string representing the AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint). --- ##### `vpcId`^Optional ```typescript public readonly vpcId: string; ``` - *Type:* string String Representing the AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint). --- ### PrivateEndpointProps #### Initializer ```typescript import { PrivateEndpointProps } from 'awscdk-resources-mongodbatlas' const privateEndpointProps: PrivateEndpointProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsSubnetId | string | *No description.* | | awsVpcId | string | *No description.* | --- ##### `awsSubnetId`^Required ```typescript public readonly awsSubnetId: string; ``` - *Type:* string --- ##### `awsVpcId`^Required ```typescript public readonly awsVpcId: string; ``` - *Type:* string --- ### ProcessArgs Advanced configuration details to add for one cluster in the specified project. #### Initializer ```typescript import { ProcessArgs } from 'awscdk-resources-mongodbatlas' const processArgs: ProcessArgs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customOpensslCipherConfigTls12 | string[] | The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tls_cipher_config_mode` is set to `CUSTOM`. | | defaultReadConcern | string | Default level of acknowledgment requested from MongoDB for read operations set for this cluster. | | defaultWriteConcern | string | Default level of acknowledgment requested from MongoDB for write operations set for this cluster. | | failIndexKeyTooLong | boolean | Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. | | javascriptEnabled | boolean | Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. | | minimumEnabledTlsProtocol | string | Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. | | noTableScan | boolean | Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results. | | oplogMinRetentionHours | number | Minimum retention window for cluster's oplog expressed in hours. | | oplogSizeMb | number | Storage limit of cluster's oplog expressed in megabytes. | | sampleRefreshIntervalBiConnector | number | Number of documents per database to sample when gathering schema information. | | sampleSizeBiConnector | number | Interval in seconds at which the mongosqld process re-samples data to create its relational schema. | | tlsCipherConfigMode | string | The TLS cipher suite configuration mode. | | transactionLifetimeLimitSeconds | number | Lifetime, in seconds, of multi-document transactions. | --- ##### `customOpensslCipherConfigTls12`^Optional ```typescript public readonly customOpensslCipherConfigTls12: string[]; ``` - *Type:* string[] The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tls_cipher_config_mode` is set to `CUSTOM`. --- ##### `defaultReadConcern`^Optional ```typescript public readonly defaultReadConcern: string; ``` - *Type:* string Default level of acknowledgment requested from MongoDB for read operations set for this cluster. --- ##### `defaultWriteConcern`^Optional ```typescript public readonly defaultWriteConcern: string; ``` - *Type:* string Default level of acknowledgment requested from MongoDB for write operations set for this cluster. --- ##### `failIndexKeyTooLong`^Optional ```typescript public readonly failIndexKeyTooLong: boolean; ``` - *Type:* boolean Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit but doesn't index them. --- ##### `javascriptEnabled`^Optional ```typescript public readonly javascriptEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. --- ##### `minimumEnabledTlsProtocol`^Optional ```typescript public readonly minimumEnabledTlsProtocol: string; ``` - *Type:* string Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version. --- ##### `noTableScan`^Optional ```typescript public readonly noTableScan: boolean; ``` - *Type:* boolean Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results. --- ##### `oplogMinRetentionHours`^Optional ```typescript public readonly oplogMinRetentionHours: number; ``` - *Type:* number Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates. --- ##### `oplogSizeMb`^Optional ```typescript public readonly oplogSizeMb: number; ``` - *Type:* number Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates. --- ##### `sampleRefreshIntervalBiConnector`^Optional ```typescript public readonly sampleRefreshIntervalBiConnector: number; ``` - *Type:* number Number of documents per database to sample when gathering schema information. --- ##### `sampleSizeBiConnector`^Optional ```typescript public readonly sampleSizeBiConnector: number; ``` - *Type:* number Interval in seconds at which the mongosqld process re-samples data to create its relational schema. --- ##### `tlsCipherConfigMode`^Optional ```typescript public readonly tlsCipherConfigMode: string; ``` - *Type:* string The TLS cipher suite configuration mode. Valid values include `CUSTOM` or `DEFAULT`. The `DEFAULT` mode uses the default cipher suites. The `CUSTOM` mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3. To unset, this should be set back to `DEFAULT`. --- ##### `transactionLifetimeLimitSeconds`^Optional ```typescript public readonly transactionLifetimeLimitSeconds: number; ``` - *Type:* number Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process. --- ### ProjectApiKey #### Initializer ```typescript import { ProjectApiKey } from 'awscdk-resources-mongodbatlas' const projectApiKey: ProjectApiKey = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project. | | roleNames | string[] | List of roles to grant this API key. | --- ##### `key`^Optional ```typescript public readonly key: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project. --- ##### `roleNames`^Optional ```typescript public readonly roleNames: string[]; ``` - *Type:* string[] List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" --- ### ProjectAssignment #### Initializer ```typescript import { ProjectAssignment } from 'awscdk-resources-mongodbatlas' const projectAssignment: ProjectAssignment = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies the project in an organization. | | roles | string[] | List of roles to grant this API key. | --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the project in an organization. --- ##### `roles`^Optional ```typescript public readonly roles: string[]; ``` - *Type:* string[] List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization. --- ### ProjectProps #### Initializer ```typescript import { ProjectProps } from 'awscdk-resources-mongodbatlas' const projectProps: ProjectProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | orgId | string | *No description.* | | clusterCount | number | *No description.* | | name | string | *No description.* | | projectApiKeys | ProjectApiKey[] | *No description.* | | projectOwnerId | string | *No description.* | | projectSettings | ProjectSettings | *No description.* | | projectTeams | ProjectTeam[] | *No description.* | | withDefaultAlertsSettings | boolean | *No description.* | --- ##### `orgId`^Required ```typescript public readonly orgId: string; ``` - *Type:* string - *Default:* auto-generated --- ##### `clusterCount`^Optional ```typescript public readonly clusterCount: number; ``` - *Type:* number --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `projectApiKeys`^Optional ```typescript public readonly projectApiKeys: ProjectApiKey[]; ``` - *Type:* ProjectApiKey[] --- ##### `projectOwnerId`^Optional ```typescript public readonly projectOwnerId: string; ``` - *Type:* string --- ##### `projectSettings`^Optional ```typescript public readonly projectSettings: ProjectSettings; ``` - *Type:* ProjectSettings --- ##### `projectTeams`^Optional ```typescript public readonly projectTeams: ProjectTeam[]; ``` - *Type:* ProjectTeam[] --- ##### `withDefaultAlertsSettings`^Optional ```typescript public readonly withDefaultAlertsSettings: boolean; ``` - *Type:* boolean --- ### ProjectSettings #### Initializer ```typescript import { ProjectSettings } from 'awscdk-resources-mongodbatlas' const projectSettings: ProjectSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | isCollectDatabaseSpecificsStatisticsEnabled | boolean | Flag that indicates whether to collect database-specific metrics for the specified project. | | isDataExplorerEnabled | boolean | Flag that indicates whether to enable the Data Explorer for the specified project. | | isExtendedStorageSizesEnabled | boolean | Flag that indicates whether to enable extended storage sizes for the specified project. | | isPerformanceAdvisorEnabled | boolean | Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. | | isRealtimePerformancePanelEnabled | boolean | Flag that indicates whether to enable the Real Time Performance Panel for the specified project. | | isSchemaAdvisorEnabled | boolean | Flag that indicates whether to enable the Schema Advisor for the specified project. | --- ##### `isCollectDatabaseSpecificsStatisticsEnabled`^Optional ```typescript public readonly isCollectDatabaseSpecificsStatisticsEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to collect database-specific metrics for the specified project. --- ##### `isDataExplorerEnabled`^Optional ```typescript public readonly isDataExplorerEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable the Data Explorer for the specified project. --- ##### `isExtendedStorageSizesEnabled`^Optional ```typescript public readonly isExtendedStorageSizesEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable extended storage sizes for the specified project. --- ##### `isPerformanceAdvisorEnabled`^Optional ```typescript public readonly isPerformanceAdvisorEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. --- ##### `isRealtimePerformancePanelEnabled`^Optional ```typescript public readonly isRealtimePerformancePanelEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable the Real Time Performance Panel for the specified project. --- ##### `isSchemaAdvisorEnabled`^Optional ```typescript public readonly isSchemaAdvisorEnabled: boolean; ``` - *Type:* boolean Flag that indicates whether to enable the Schema Advisor for the specified project. --- ### ProjectTeam #### Initializer ```typescript import { ProjectTeam } from 'awscdk-resources-mongodbatlas' const projectTeam: ProjectTeam = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleNames | string[] | One or more organization- or project-level roles to assign to the MongoDB Cloud user. | | teamId | string | Unique 24-hexadecimal character string that identifies the team. | --- ##### `roleNames`^Optional ```typescript public readonly roleNames: string[]; ``` - *Type:* string[] One or more organization- or project-level roles to assign to the MongoDB Cloud user. tems Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" --- ##### `teamId`^Optional ```typescript public readonly teamId: string; ``` - *Type:* string Unique 24-hexadecimal character string that identifies the team. string = 24 characters ^([a-f0-9]{24})$ --- ### ProviderSettings Group of cloud provider settings that configure the provisioned MongoDB flex cluster. #### Initializer ```typescript import { ProviderSettings } from 'awscdk-resources-mongodbatlas' const providerSettings: ProviderSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | backingProviderName | string | Cloud service provider on which MongoDB Cloud provisioned the flex cluster. | | regionName | string | Human-readable label that identifies the geographic location of your MongoDB flex cluster. | | diskSizeGb | number | Storage capacity available to the flex cluster expressed in gigabytes. | | providerName | string | Human-readable label that identifies the cloud service provider. | --- ##### `backingProviderName`^Required ```typescript public readonly backingProviderName: string; ``` - *Type:* string Cloud service provider on which MongoDB Cloud provisioned the flex cluster. --- ##### `regionName`^Required ```typescript public readonly regionName: string; ``` - *Type:* string Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. --- ##### `diskSizeGb`^Optional ```typescript public readonly diskSizeGb: number; ``` - *Type:* number Storage capacity available to the flex cluster expressed in gigabytes. --- ##### `providerName`^Optional ```typescript public readonly providerName: string; ``` - *Type:* string Human-readable label that identifies the cloud service provider. --- ### ReadPreference #### Initializer ```typescript import { ReadPreference } from 'awscdk-resources-mongodbatlas' const readPreference: ReadPreference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxStalenessSeconds | string | Maximum replication lag, or staleness, for reads from secondaries. | | mode | string | "primary" "primaryPreferred" "secondary" "secondaryPreferred" "nearest" Read preference mode that specifies to which replica set member to route the read requests. | | tagSets | TagSet[][] | List that contains tag sets or tag specification documents. | --- ##### `maxStalenessSeconds`^Optional ```typescript public readonly maxStalenessSeconds: string; ``` - *Type:* string Maximum replication lag, or staleness, for reads from secondaries. --- ##### `mode`^Optional ```typescript public readonly mode: string; ``` - *Type:* string "primary" "primaryPreferred" "secondary" "secondaryPreferred" "nearest" Read preference mode that specifies to which replica set member to route the read requests. --- ##### `tagSets`^Optional ```typescript public readonly tagSets: TagSet[][]; ``` - *Type:* TagSet[][] List that contains tag sets or tag specification documents. If specified, Atlas Data Federation routes read requests to replica set member or members that are associated with the specified tags. --- ### Resource List of resources on which you grant the action. #### Initializer ```typescript import { Resource } from 'awscdk-resources-mongodbatlas' const resource: Resource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cluster | boolean | Flag that indicates whether to grant the action on the cluster resource. | | collection | string | Human-readable label that identifies the collection on which you grant the action to one MongoDB user. | | db | string | Human-readable label that identifies the database on which you grant the action to one MongoDB user. | --- ##### `cluster`^Optional ```typescript public readonly cluster: boolean; ``` - *Type:* boolean Flag that indicates whether to grant the action on the cluster resource. If true, MongoDB Cloud ignores the actions.resources.collection and actions.resources.db parameters. --- ##### `collection`^Optional ```typescript public readonly collection: string; ``` - *Type:* string Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all collections. --- ##### `db`^Optional ```typescript public readonly db: string; ``` - *Type:* string Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter. Use the empty string ("") to allow an action on all databases. --- ### RoleAssignment #### Initializer ```typescript import { RoleAssignment } from 'awscdk-resources-mongodbatlas' const roleAssignment: RoleAssignment = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | orgId | string | List that contains comma-separated key value pairs to map zones to geographic regions. | | projectId | string | List that contains comma-separated key value pairs to map zones to geographic regions. | | role | string | *No description.* | --- ##### `orgId`^Optional ```typescript public readonly orgId: string; ``` - *Type:* string List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. This parameter returns an empty object if no custom zones exist. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. This parameter returns an empty object if no custom zones exist. --- ##### `role`^Optional ```typescript public readonly role: string; ``` - *Type:* string --- ### RoleDefinition #### Initializer ```typescript import { RoleDefinition } from 'awscdk-resources-mongodbatlas' const roleDefinition: RoleDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collectionName | string | *No description.* | | databaseName | string | *No description.* | | roleName | string | *No description.* | --- ##### `collectionName`^Optional ```typescript public readonly collectionName: string; ``` - *Type:* string --- ##### `databaseName`^Optional ```typescript public readonly databaseName: string; ``` - *Type:* string --- ##### `roleName`^Optional ```typescript public readonly roleName: string; ``` - *Type:* string --- ### ScheduleConfig #### Initializer ```typescript import { ScheduleConfig } from 'awscdk-resources-mongodbatlas' const scheduleConfig: ScheduleConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | schedule | string | A [cron expression](https://www.mongodb.com/docs/atlas/app-services/triggers/scheduled-triggers/#cron-expressions) that specifies when the trigger executes. | | skipcatchupEvents | boolean | If `true`, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled. | --- ##### `schedule`^Optional ```typescript public readonly schedule: string; ``` - *Type:* string A [cron expression](https://www.mongodb.com/docs/atlas/app-services/triggers/scheduled-triggers/#cron-expressions) that specifies when the trigger executes. --- ##### `skipcatchupEvents`^Optional ```typescript public readonly skipcatchupEvents: boolean; ``` - *Type:* boolean If `true`, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled. --- ### ScheduledPolicyItem Scheduled backup policy item configuration (hourly, daily, weekly, monthly, or yearly). When provided, FrequencyInterval, RetentionUnit, and RetentionValue are required. #### Initializer ```typescript import { ScheduledPolicyItem } from 'awscdk-resources-mongodbatlas' const scheduledPolicyItem: ScheduledPolicyItem = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | frequencyInterval | number | Desired frequency of the new backup policy item specified by frequencyType. | | frequencyType | string | Frequency associated with the backup policy item. | | id | string | Unique identifier of the backup policy item. | | retentionUnit | ScheduledPolicyItemRetentionUnit | Unit of time in which MongoDB Cloud measures snapshot retention. | | retentionValue | number | Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. | --- ##### `frequencyInterval`^Optional ```typescript public readonly frequencyInterval: number; ``` - *Type:* number Desired frequency of the new backup policy item specified by frequencyType. Required when the policy item is provided. --- ##### `frequencyType`^Optional ```typescript public readonly frequencyType: string; ``` - *Type:* string Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly, monthly, or yearly. This is a read-only value. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the backup policy item. --- ##### `retentionUnit`^Optional ```typescript public readonly retentionUnit: ScheduledPolicyItemRetentionUnit; ``` - *Type:* ScheduledPolicyItemRetentionUnit Unit of time in which MongoDB Cloud measures snapshot retention. Required when the policy item is provided. --- ##### `retentionValue`^Optional ```typescript public readonly retentionValue: number; ``` - *Type:* number Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. Required when the policy item is provided. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. --- ### ScheduleView #### Initializer ```typescript import { ScheduleView } from 'awscdk-resources-mongodbatlas' const scheduleView: ScheduleView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dayOfMonth | number | Day of the month when the scheduled archive starts. | | dayOfWeek | number | Day of the month when the scheduled archive starts. | | endHour | number | Hour of the day when the scheduled window to run one online archive ends. | | endMinute | number | Minute of the hour when the scheduled window to run one online archive ends. | | startHour | number | Hour of the day when the when the scheduled window to run one online archive starts. | | startMinute | number | Minute of the hour when the scheduled window to run one online archive starts. | | type | ScheduleViewType | *No description.* | --- ##### `dayOfMonth`^Optional ```typescript public readonly dayOfMonth: number; ``` - *Type:* number Day of the month when the scheduled archive starts. --- ##### `dayOfWeek`^Optional ```typescript public readonly dayOfWeek: number; ``` - *Type:* number Day of the month when the scheduled archive starts. --- ##### `endHour`^Optional ```typescript public readonly endHour: number; ``` - *Type:* number Hour of the day when the scheduled window to run one online archive ends. --- ##### `endMinute`^Optional ```typescript public readonly endMinute: number; ``` - *Type:* number Minute of the hour when the scheduled window to run one online archive ends. --- ##### `startHour`^Optional ```typescript public readonly startHour: number; ``` - *Type:* number Hour of the day when the when the scheduled window to run one online archive starts. --- ##### `startMinute`^Optional ```typescript public readonly startMinute: number; ``` - *Type:* number Minute of the hour when the scheduled window to run one online archive starts. --- ##### `type`^Optional ```typescript public readonly type: ScheduleViewType; ``` - *Type:* ScheduleViewType --- ### SchemaRegistryAuthentication Authentication configuration for Schema Registry. #### Initializer ```typescript import { SchemaRegistryAuthentication } from 'awscdk-resources-mongodbatlas' const schemaRegistryAuthentication: SchemaRegistryAuthentication = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | string | Password or Private Key for authentication. | | type | string | Authentication type discriminator. | | username | string | Username or Public Key for authentication. | --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string Password or Private Key for authentication. Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Authentication type discriminator. Specifies the authentication mechanism for Schema Registry. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string Username or Public Key for authentication. --- ### ScopeDefinition #### Initializer ```typescript import { ScopeDefinition } from 'awscdk-resources-mongodbatlas' const scopeDefinition: ScopeDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | type | ScopeDefinitionType | *No description.* | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ##### `type`^Optional ```typescript public readonly type: ScopeDefinitionType; ``` - *Type:* ScopeDefinitionType --- ### Secret #### Initializer ```typescript import { Secret } from 'awscdk-resources-mongodbatlas' const secret: Secret = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | createdAt | string | Date and time that the secret was created on. | | expiresAt | string | Date and time when the secret expires. | | id | string | Unique identifier of the secret. | | lastUsedAt | string | Date and time when the secret was last used. | | maskedSecretValue | string | Masked value of the secret. | | secret | string | The secret value. | --- ##### `createdAt`^Optional ```typescript public readonly createdAt: string; ``` - *Type:* string Date and time that the secret was created on. --- ##### `expiresAt`^Optional ```typescript public readonly expiresAt: string; ``` - *Type:* string Date and time when the secret expires. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the secret. --- ##### `lastUsedAt`^Optional ```typescript public readonly lastUsedAt: string; ``` - *Type:* string Date and time when the secret was last used. --- ##### `maskedSecretValue`^Optional ```typescript public readonly maskedSecretValue: string; ``` - *Type:* string Masked value of the secret. --- ##### `secret`^Optional ```typescript public readonly secret: string; ``` - *Type:* string The secret value. Only returned on create. --- ### SecretDefinition #### Initializer ```typescript import { SecretDefinition } from 'awscdk-resources-mongodbatlas' const secretDefinition: SecretDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | createdAt | string | Date and time that the secret was created on. | | expiresAt | string | Date and time when the secret expires. | | id | string | Unique identifier of the secret. | | lastUsedAt | string | Date and time when the secret was last used. | | maskedSecretValue | string | Masked value of the secret. | | secret | string | The secret value. | --- ##### `createdAt`^Optional ```typescript public readonly createdAt: string; ``` - *Type:* string Date and time that the secret was created on. --- ##### `expiresAt`^Optional ```typescript public readonly expiresAt: string; ``` - *Type:* string Date and time when the secret expires. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string Unique identifier of the secret. --- ##### `lastUsedAt`^Optional ```typescript public readonly lastUsedAt: string; ``` - *Type:* string Date and time when the secret was last used. --- ##### `maskedSecretValue`^Optional ```typescript public readonly maskedSecretValue: string; ``` - *Type:* string Masked value of the secret. --- ##### `secret`^Optional ```typescript public readonly secret: string; ``` - *Type:* string The secret value. Only returned on create. --- ### Specs #### Initializer ```typescript import { Specs } from 'awscdk-resources-mongodbatlas' const specs: Specs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | diskIops | string | Target throughput desired for storage attached to your AWS-provisioned cluster. Only change this parameter if you:. | | ebsVolumeType | string | Type of storage you want to attach to your AWS-provisioned cluster. | | instanceSize | string | Hardware specification for the instance sizes in this region. | | nodeCount | number | Number of read-only nodes for MongoDB Cloud deploys to the region. | --- ##### `diskIops`^Optional ```typescript public readonly diskIops: string; ``` - *Type:* string Target throughput desired for storage attached to your AWS-provisioned cluster. Only change this parameter if you:. set "replicationSpecs[n].regionConfigs[m].providerName" : "AWS". set "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M30" or greater not including Mxx_NVME tiers. The maximum input/output operations per second (IOPS) depend on the selected .instanceSize and .diskSizeGB. This parameter defaults to the cluster tier's standard IOPS value. Changing this value impacts cluster cost. MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets. Instance sizes M10 to M40 have a ratio of disk capacity to system memory of 60:1. Instance sizes greater than M40 have a ratio of 120:1. --- ##### `ebsVolumeType`^Optional ```typescript public readonly ebsVolumeType: string; ``` - *Type:* string Type of storage you want to attach to your AWS-provisioned cluster. STANDARD volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size." --- ##### `instanceSize`^Optional ```typescript public readonly instanceSize: string; ``` - *Type:* string Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. If you deploy a Global Cluster, you must choose a instance size of M30 or greater. --- ##### `nodeCount`^Optional ```typescript public readonly nodeCount: number; ``` - *Type:* number Number of read-only nodes for MongoDB Cloud deploys to the region. Read-only nodes can never become the primary, but can enable local reads. --- ### Storage Configuration information for each data store and its mapping to MongoDB Cloud databases. #### Initializer ```typescript import { Storage } from 'awscdk-resources-mongodbatlas' const storage: Storage = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databases | Database[] | Array that contains the queryable databases and collections for this Atlas Data Federation. | | stores | Store[] | Array that contains the data stores for the Atlas Data Federation. | --- ##### `databases`^Optional ```typescript public readonly databases: Database[]; ``` - *Type:* Database[] Array that contains the queryable databases and collections for this Atlas Data Federation. --- ##### `stores`^Optional ```typescript public readonly stores: Store[]; ``` - *Type:* Store[] Array that contains the data stores for the Atlas Data Federation. --- ### Store Array that contains the data stores for the Atlas Data Federation. #### Initializer ```typescript import { Store } from 'awscdk-resources-mongodbatlas' const store: Store = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterName | string | Human-readable label of the MongoDB Cloud cluster on which the store is based. | | name | string | Human-readable label that identifies the data store. | | projectId | string | Unique 24-hexadecimal digit string that identifies the project.Regex ^([a-f0-9]{24})$ . | | provider | string | Allowed values atlas, http, online_archive, s3 and DataLakeAzureBlobStore. | | readPreference | ReadPreference | MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster. | --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string Human-readable label of the MongoDB Cloud cluster on which the store is based. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the Atlas Data Federation requires an M10 or higher cluster. --- ##### `projectId`^Optional ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies the project.Regex ^([a-f0-9]{24})$ . --- ##### `provider`^Optional ```typescript public readonly provider: string; ``` - *Type:* string Allowed values atlas, http, online_archive, s3 and DataLakeAzureBlobStore. --- ##### `readPreference`^Optional ```typescript public readonly readPreference: ReadPreference; ``` - *Type:* ReadPreference MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster. --- ### StreamConfig Configuration options for an Atlas Stream Processing Workspace. #### Initializer ```typescript import { StreamConfig } from 'awscdk-resources-mongodbatlas' const streamConfig: StreamConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | tier | string | Selected tier for the Stream Workspace. | | maxTierSize | string | Max tier size for the Stream Workspace. | --- ##### `tier`^Required ```typescript public readonly tier: string; ``` - *Type:* string Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. Valid values: SP2, SP5, SP10, SP30, SP50. --- ##### `maxTierSize`^Optional ```typescript public readonly maxTierSize: string; ``` - *Type:* string Max tier size for the Stream Workspace. Configures Memory / VCPU allowances. Valid values: SP2, SP5, SP10, SP30, SP50. --- ### StreamsConnection Settings that define a connection to an external data store. #### Initializer ```typescript import { StreamsConnection } from 'awscdk-resources-mongodbatlas' const streamsConnection: StreamsConnection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authentication | StreamsKafkaAuthentication | *No description.* | | bootstrapServers | string | Comma separated list of server addresses. | | clusterName | string | Name of the cluster configured for this connection. | | dbRoleToExecute | DbRoleToExecute | *No description.* | | name | string | Human-readable label that identifies the stream connection. | | security | StreamsKafkaSecurity | *No description.* | | type | StreamsConnectionType | Type of the connection. | --- ##### `authentication`^Optional ```typescript public readonly authentication: StreamsKafkaAuthentication; ``` - *Type:* StreamsKafkaAuthentication --- ##### `bootstrapServers`^Optional ```typescript public readonly bootstrapServers: string; ``` - *Type:* string Comma separated list of server addresses. --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string Name of the cluster configured for this connection. --- ##### `dbRoleToExecute`^Optional ```typescript public readonly dbRoleToExecute: DbRoleToExecute; ``` - *Type:* DbRoleToExecute --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the stream connection. --- ##### `security`^Optional ```typescript public readonly security: StreamsKafkaSecurity; ``` - *Type:* StreamsKafkaSecurity --- ##### `type`^Optional ```typescript public readonly type: StreamsConnectionType; ``` - *Type:* StreamsConnectionType Type of the connection. Can be either Cluster or Kafka. --- ### StreamsDataProcessRegion Information about the cloud provider region in which MongoDB Cloud processes the stream. #### Initializer ```typescript import { StreamsDataProcessRegion } from 'awscdk-resources-mongodbatlas' const streamsDataProcessRegion: StreamsDataProcessRegion = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudProvider | StreamsDataProcessRegionCloudProvider | Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. | | region | string | *No description.* | --- ##### `cloudProvider`^Required ```typescript public readonly cloudProvider: StreamsDataProcessRegionCloudProvider; ``` - *Type:* StreamsDataProcessRegionCloudProvider Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. For CloudFormation, this is restricted to AWS only. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string --- ### StreamsDlq Dead letter queue for the stream processor. Refer to the MongoDB Atlas Docs for more information. #### Initializer ```typescript import { StreamsDlq } from 'awscdk-resources-mongodbatlas' const streamsDlq: StreamsDlq = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | coll | string | Name of the collection to use for the DLQ. | | connectionName | string | Name of the connection to write DLQ messages to. | | db | string | Name of the database to use for the DLQ. | --- ##### `coll`^Required ```typescript public readonly coll: string; ``` - *Type:* string Name of the collection to use for the DLQ. --- ##### `connectionName`^Required ```typescript public readonly connectionName: string; ``` - *Type:* string Name of the connection to write DLQ messages to. Must be an Atlas connection. --- ##### `db`^Required ```typescript public readonly db: string; ``` - *Type:* string Name of the database to use for the DLQ. --- ### StreamsKafkaAuthentication User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode. #### Initializer ```typescript import { StreamsKafkaAuthentication } from 'awscdk-resources-mongodbatlas' const streamsKafkaAuthentication: StreamsKafkaAuthentication = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientId | string | OAuth client ID. | | clientSecret | string | OAuth client secret. | | mechanism | string | Style of authentication. | | method | string | OAuth authentication method. | | password | string | Password of the account to connect to the Kafka cluster. | | saslOauthbearerExtensions | string | SASL OAuth bearer extensions. | | scope | string | OAuth scope. | | sslCertificate | string | SSL certificate for client authentication to Kafka. | | sslKey | string | SSL key for client authentication to Kafka. | | sslKeyPassword | string | Password for the SSL key, if it is password protected. | | tokenEndpointUrl | string | OAuth token endpoint URL. | | username | string | Username of the account to connect to the Kafka cluster. | --- ##### `clientId`^Optional ```typescript public readonly clientId: string; ``` - *Type:* string OAuth client ID. --- ##### `clientSecret`^Optional ```typescript public readonly clientSecret: string; ``` - *Type:* string OAuth client secret. Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials. --- ##### `mechanism`^Optional ```typescript public readonly mechanism: string; ``` - *Type:* string Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER. --- ##### `method`^Optional ```typescript public readonly method: string; ``` - *Type:* string OAuth authentication method. --- ##### `password`^Optional ```typescript public readonly password: string; ``` - *Type:* string Password of the account to connect to the Kafka cluster. Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials. --- ##### `saslOauthbearerExtensions`^Optional ```typescript public readonly saslOauthbearerExtensions: string; ``` - *Type:* string SASL OAuth bearer extensions. --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string OAuth scope. --- ##### `sslCertificate`^Optional ```typescript public readonly sslCertificate: string; ``` - *Type:* string SSL certificate for client authentication to Kafka. --- ##### `sslKey`^Optional ```typescript public readonly sslKey: string; ``` - *Type:* string SSL key for client authentication to Kafka. Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials. --- ##### `sslKeyPassword`^Optional ```typescript public readonly sslKeyPassword: string; ``` - *Type:* string Password for the SSL key, if it is password protected. Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials. --- ##### `tokenEndpointUrl`^Optional ```typescript public readonly tokenEndpointUrl: string; ``` - *Type:* string OAuth token endpoint URL. --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string Username of the account to connect to the Kafka cluster. --- ### StreamsKafkaSecurity Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. #### Initializer ```typescript import { StreamsKafkaSecurity } from 'awscdk-resources-mongodbatlas' const streamsKafkaSecurity: StreamsKafkaSecurity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | brokerPublicCertificate | string | A trusted, public x509 certificate for connecting to Kafka over SSL. | | protocol | string | Describes the transport type. | --- ##### `brokerPublicCertificate`^Optional ```typescript public readonly brokerPublicCertificate: string; ``` - *Type:* string A trusted, public x509 certificate for connecting to Kafka over SSL. --- ##### `protocol`^Optional ```typescript public readonly protocol: string; ``` - *Type:* string Describes the transport type. Can be either PLAINTEXT or SSL. --- ### StreamsOptions Optional configuration for the stream processor. #### Initializer ```typescript import { StreamsOptions } from 'awscdk-resources-mongodbatlas' const streamsOptions: StreamsOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dlq | StreamsDlq | *No description.* | --- ##### `dlq`^Required ```typescript public readonly dlq: StreamsDlq; ``` - *Type:* StreamsDlq --- ### SynchronousCreationOptions Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE. #### Initializer ```typescript import { SynchronousCreationOptions } from 'awscdk-resources-mongodbatlas' const synchronousCreationOptions: SynchronousCreationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | callbackDelaySeconds | number | Represents the time interval, measured in seconds, for the synchronous process to wait before checking again to verify if the job has been completed. | | returnSuccessIfTimeOut | boolean | if set to true, the process will return success, in the event of a timeOut, default false. | | timeOutInSeconds | number | The amount of time the process will wait until exiting with a success, default (1200 seconds). | --- ##### `callbackDelaySeconds`^Optional ```typescript public readonly callbackDelaySeconds: number; ``` - *Type:* number Represents the time interval, measured in seconds, for the synchronous process to wait before checking again to verify if the job has been completed. example: if set to 20, it will chek every 20 seconds if the resource is completed, default (30 seconds) --- ##### `returnSuccessIfTimeOut`^Optional ```typescript public readonly returnSuccessIfTimeOut: boolean; ``` - *Type:* boolean if set to true, the process will return success, in the event of a timeOut, default false. --- ##### `timeOutInSeconds`^Optional ```typescript public readonly timeOutInSeconds: number; ``` - *Type:* number The amount of time the process will wait until exiting with a success, default (1200 seconds). --- ### SynonymSource #### Initializer ```typescript import { SynonymSource } from 'awscdk-resources-mongodbatlas' const synonymSource: SynonymSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collection | string | Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms. | --- ##### `collection`^Required ```typescript public readonly collection: string; ``` - *Type:* string Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms. --- ### Tag List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. #### Initializer ```typescript import { Tag } from 'awscdk-resources-mongodbatlas' const tag: Tag = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | Constant that defines the set of the tag. | | value | string | Variable that belongs to the set of the tag. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string Constant that defines the set of the tag. For example, environment in the environment : production tag. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string Variable that belongs to the set of the tag. For example, production in the environment : production tag. --- ### TagSet #### Initializer ```typescript import { TagSet } from 'awscdk-resources-mongodbatlas' const tagSet: TagSet = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label of the tag. | | value | string | Human-readable label of the tag. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label of the tag. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string Human-readable label of the tag. --- ### ThirdPartyIntegrationProps #### Initializer ```typescript import { ThirdPartyIntegrationProps } from 'awscdk-resources-mongodbatlas' const thirdPartyIntegrationProps: ThirdPartyIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | profile | string | Atlas API keys. | --- ##### `projectId`^Required ```typescript public readonly projectId: string; ``` - *Type:* string Unique 24-hexadecimal digit string that identifies your project. --- ##### `profile`^Optional ```typescript public readonly profile: string; ``` - *Type:* string Atlas API keys. --- ### Timeouts Configurable timeouts for stream processor operations. #### Initializer ```typescript import { Timeouts } from 'awscdk-resources-mongodbatlas' const timeouts: Timeouts = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | create | string | Timeout for create operation in Go duration format (e.g., '5m', '10s'). Default is 20 minutes. | --- ##### `create`^Optional ```typescript public readonly create: string; ``` - *Type:* string - *Default:* 20 minutes. Timeout for create operation in Go duration format (e.g., '5m', '10s'). Default is 20 minutes. --- ### TypeSet #### Initializer ```typescript import { TypeSet } from 'awscdk-resources-mongodbatlas' const typeSet: TypeSet = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that identifies this type set. | | types | string | Stringify json representation of types array. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies this type set. --- ##### `types`^Optional ```typescript public readonly types: string; ``` - *Type:* string Stringify json representation of types array. Each type defines a field type for the search index. --- ### Validation #### Initializer ```typescript import { Validation } from 'awscdk-resources-mongodbatlas' const validation: Validation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | status | string | *No description.* | | validationType | string | *No description.* | --- ##### `status`^Optional ```typescript public readonly status: string; ``` - *Type:* string --- ##### `validationType`^Optional ```typescript public readonly validationType: string; ``` - *Type:* string --- ### View #### Initializer ```typescript import { View } from 'awscdk-resources-mongodbatlas' const view: View = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. | | pipeline | string | Aggregation pipeline stages to apply to the source collection. | | source | string | Human-readable label that identifies the source collection for the view. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. --- ##### `pipeline`^Optional ```typescript public readonly pipeline: string; ``` - *Type:* string Aggregation pipeline stages to apply to the source collection. --- ##### `source`^Optional ```typescript public readonly source: string; ``` - *Type:* string Human-readable label that identifies the source collection for the view. --- ### ZoneMapping #### Initializer ```typescript import { ZoneMapping } from 'awscdk-resources-mongodbatlas' const zoneMapping: ZoneMapping = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | string | Code that represents a location that maps to a zone in your global cluster. | | zone | string | Human-readable label that identifies the zone in your global cluster. | --- ##### `location`^Optional ```typescript public readonly location: string; ``` - *Type:* string Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible. --- ##### `zone`^Optional ```typescript public readonly zone: string; ``` - *Type:* string Human-readable label that identifies the zone in your global cluster. This zone maps to a location code. --- ## Classes ### MongoAtlasBootstrapProps #### Initializers ```typescript import { MongoAtlasBootstrapProps } from 'awscdk-resources-mongodbatlas' new MongoAtlasBootstrapProps() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleName | string | The IAM role name for CloudFormation Extension Execution. | | secretProfile | string | The secret profile name for MongoDB Atlas. | | typesToActivate | string[] | List of strings representing mongoDB atlas types to activate. | --- ##### `roleName`^Required ```typescript public readonly roleName: string; ``` - *Type:* string - *Default:* auto generat the name. The IAM role name for CloudFormation Extension Execution. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) --- ##### `secretProfile`^Required ```typescript public readonly secretProfile: string; ``` - *Type:* string - *Default:* generate a dummy secret. The secret profile name for MongoDB Atlas. > [https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master#2-configure-your-profile](https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master#2-configure-your-profile) --- ##### `typesToActivate`^Optional ```typescript public readonly typesToActivate: string[]; ``` - *Type:* string[] List of strings representing mongoDB atlas types to activate. the exported AtlasBasicResources can be used for AtlasBasic resources if not provided non resources will be activated --- *Example* ```typescript typesToActivate=["Cluster","Project"] this will actiate MongoDB::Atlas::Project && MongoDB::Atlas::Cluster ``` ## Enums ### AdvancedRegionConfigProviderName #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | | GCP | GCP. | | AZURE | AZURE. | | TENANT | TENANT. | | FLEX | FLEX. | --- ##### `AWS` AWS. --- ##### `GCP` GCP. --- ##### `AZURE` AZURE. --- ##### `TENANT` TENANT. --- ##### `FLEX` FLEX. --- ### ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `"type": "replicaSet".` #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | | AZURE | AZURE. | | GCP | GCP. | --- ##### `AWS` AWS. --- ##### `AZURE` AZURE. --- ##### `GCP` GCP. --- ### ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType Human-readable label that identifies how often this snapshot triggers. #### Members | **Name** | **Description** | | --- | --- | | HOURLY | hourly. | | DAILY | daily. | | WEEKLY | weekly. | | MONTHLY | monthly. | --- ##### `HOURLY` hourly. --- ##### `DAILY` daily. --- ##### `WEEKLY` weekly. --- ##### `MONTHLY` monthly. --- ### ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType Human-readable label that identifies when this snapshot triggers. #### Members | **Name** | **Description** | | --- | --- | | ON_DEMAND | onDemand. | | SCHEDULED | scheduled. | --- ##### `ON_DEMAND` onDemand. --- ##### `SCHEDULED` scheduled. --- ### ApiAtlasDiskBackupShardedClusterSnapshotViewStatus Human-readable label that indicates the stage of the backup process for this snapshot. #### Members | **Name** | **Description** | | --- | --- | | QUEUED | queued. | | IN_PROGRESS | inProgress. | | COMPLETED | completed. | | FAILED | failed. | --- ##### `QUEUED` queued. --- ##### `IN_PROGRESS` inProgress. --- ##### `COMPLETED` completed. --- ##### `FAILED` failed. --- ### ApiAtlasDiskBackupShardedClusterSnapshotViewType Human-readable label that categorizes the cluster as a replica set or sharded cluster. #### Members | **Name** | **Description** | | --- | --- | | REPLICA_SET | REPLICA_SET. | | SHARDED_CLUSTER | SHARDED_CLUSTER. | --- ##### `REPLICA_SET` REPLICA_SET. --- ##### `SHARDED_CLUSTER` SHARDED_CLUSTER. --- ### AtlasRoleRoleName Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. Organization Roles * ORG_OWNER * ORG_MEMBER * ORG_GROUP_CREATOR * ORG_BILLING_ADMIN * ORG_READ_ONLY Project Roles * GROUP_CLUSTER_MANAGER * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_ONLY * GROUP_DATA_ACCESS_READ_WRITE * GROUP_OWNER * GROUP_READ_ONLY #### Members | **Name** | **Description** | | --- | --- | | ORG_OWNER | ORG_OWNER. | | ORG_MEMBER | ORG_MEMBER. | | ORG_GROUP_CREATOR | ORG_GROUP_CREATOR. | | ORG_BILLING_ADMIN | ORG_BILLING_ADMIN. | | ORG_READ_ONLY | ORG_READ_ONLY. | | GROUP_CLUSTER_MANAGER | GROUP_CLUSTER_MANAGER. | | GROUP_DATA_ACCESS_ADMIN | GROUP_DATA_ACCESS_ADMIN. | | GROUP_DATA_ACCESS_READ_ONLY | GROUP_DATA_ACCESS_READ_ONLY. | | GROUP_DATA_ACCESS_READ_WRITE | GROUP_DATA_ACCESS_READ_WRITE. | | GROUP_OWNER | GROUP_OWNER. | | GROUP_READ_ONLY | GROUP_READ_ONLY. | --- ##### `ORG_OWNER` ORG_OWNER. --- ##### `ORG_MEMBER` ORG_MEMBER. --- ##### `ORG_GROUP_CREATOR` ORG_GROUP_CREATOR. --- ##### `ORG_BILLING_ADMIN` ORG_BILLING_ADMIN. --- ##### `ORG_READ_ONLY` ORG_READ_ONLY. --- ##### `GROUP_CLUSTER_MANAGER` GROUP_CLUSTER_MANAGER. --- ##### `GROUP_DATA_ACCESS_ADMIN` GROUP_DATA_ACCESS_ADMIN. --- ##### `GROUP_DATA_ACCESS_READ_ONLY` GROUP_DATA_ACCESS_READ_ONLY. --- ##### `GROUP_DATA_ACCESS_READ_WRITE` GROUP_DATA_ACCESS_READ_WRITE. --- ##### `GROUP_OWNER` GROUP_OWNER. --- ##### `GROUP_READ_ONLY` GROUP_READ_ONLY. --- ### AuthConfigOperationType The type of authentication event that the trigger listens for. #### Members | **Name** | **Description** | | --- | --- | | LOGIN | LOGIN. | | CREATE | CREATE. | | DELETE | DELETE. | --- ##### `LOGIN` LOGIN. --- ##### `CREATE` CREATE. --- ##### `DELETE` DELETE. --- ### AuthConfigProviders #### Members | **Name** | **Description** | | --- | --- | | ANON_USER | anon-user. | | API_KEY | api-key. | | CUSTOM_TOKEN | custom-token. | | CUSTOM_FUNCTION | custom-function. | | LOCAL_USERPASS | local-userpass. | | OAUTH2_APPLE | oauth2-apple. | | OAUTH2_FACEBOOK | oauth2-facebook. | | OAUTH2_GOOGLE | oauth2-google. | --- ##### `ANON_USER` anon-user. --- ##### `API_KEY` api-key. --- ##### `CUSTOM_TOKEN` custom-token. --- ##### `CUSTOM_FUNCTION` custom-function. --- ##### `LOCAL_USERPASS` local-userpass. --- ##### `OAUTH2_APPLE` oauth2-apple. --- ##### `OAUTH2_FACEBOOK` oauth2-facebook. --- ##### `OAUTH2_GOOGLE` oauth2-google. --- ### CfnCloudBackUpRestoreJobsPropsDeliveryType Type of restore job to create.The value can be any one of download,automated or point_in_time. #### Members | **Name** | **Description** | | --- | --- | | DOWNLOAD | download. | | AUTOMATED | automated. | | POINT_IN_TIME | pointInTime. | --- ##### `DOWNLOAD` download. --- ##### `AUTOMATED` automated. --- ##### `POINT_IN_TIME` pointInTime. --- ### CfnCloudBackUpRestoreJobsPropsInstanceType Type of instance specified on the Instance Name. #### Members | **Name** | **Description** | | --- | --- | | CLUSTER | cluster. | --- ##### `CLUSTER` cluster. --- ### CfnCloudBackupSnapshotPropsFrequencyType Human-readable label that identifies how often this snapshot triggers. #### Members | **Name** | **Description** | | --- | --- | | HOURLY | hourly. | | DAILY | daily. | | WEEKLY | weekly. | | MONTHLY | monthly. | --- ##### `HOURLY` hourly. --- ##### `DAILY` daily. --- ##### `WEEKLY` weekly. --- ##### `MONTHLY` monthly. --- ### CfnCloudBackupSnapshotPropsInstanceType Type of instance specified on the Instance Name. #### Members | **Name** | **Description** | | --- | --- | | CLUSTER | cluster. | --- ##### `CLUSTER` cluster. --- ### CfnCloudBackupSnapshotPropsSnapshotType Human-readable label that identifies when this snapshot triggers. #### Members | **Name** | **Description** | | --- | --- | | ON_DEMAND | onDemand. | | SCHEDULED | scheduled. | --- ##### `ON_DEMAND` onDemand. --- ##### `SCHEDULED` scheduled. --- ### CfnClusterPropsEncryptionAtRestProvider Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be M10 or higher and "backupEnabled" : false or omitted entirely. #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | | GCP | GCP. | | AZURE | AZURE. | | NONE | NONE. | --- ##### `AWS` AWS. --- ##### `GCP` GCP. --- ##### `AZURE` AZURE. --- ##### `NONE` NONE. --- ### CfnDatabaseUserPropsAwsiamType 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`. #### Members | **Name** | **Description** | | --- | --- | | NONE | NONE. | | USER | USER. | | ROLE | ROLE. | --- ##### `NONE` NONE. --- ##### `USER` USER. --- ##### `ROLE` ROLE. --- ### CfnDatabaseUserPropsLdapAuthType Method by which the provided username is authenticated. Default value is `NONE`. #### Members | **Name** | **Description** | | --- | --- | | NONE | NONE. | | USER | USER. | | GROUP | GROUP. | --- ##### `NONE` NONE. --- ##### `USER` USER. --- ##### `GROUP` GROUP. --- ### CfnDatabaseUserPropsOidcAuthType Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field. Default value is `NONE`. #### Members | **Name** | **Description** | | --- | --- | | NONE | NONE. | | USER | USER. | | IDP_GROUP | IDP_GROUP. | --- ##### `NONE` NONE. --- ##### `USER` USER. --- ##### `IDP_GROUP` IDP_GROUP. --- ### CfnDatabaseUserPropsX509Type Method that briefs who owns the certificate provided. Default value is `NONE`. #### Members | **Name** | **Description** | | --- | --- | | NONE | NONE. | | MANAGED | MANAGED. | | CUSTOMER | CUSTOMER. | --- ##### `NONE` NONE. --- ##### `MANAGED` MANAGED. --- ##### `CUSTOMER` CUSTOMER. --- ### CfnFederatedQueryLimitPropsLimitName Human-readable label that identifies this data federation instance limit. #### Members | **Name** | **Description** | | --- | --- | | BYTES_PROCESSED_QUERY | bytesProcessed.query. | | BYTES_PROCESSED_DAILY | bytesProcessed.daily. | | BYTES_PROCESSED_WEEKLY | bytesProcessed.weekly. | | BYTES_PROCESSED_MONTHLY | bytesProcessed.monthly. | --- ##### `BYTES_PROCESSED_QUERY` bytesProcessed.query. --- ##### `BYTES_PROCESSED_DAILY` bytesProcessed.daily. --- ##### `BYTES_PROCESSED_WEEKLY` bytesProcessed.weekly. --- ##### `BYTES_PROCESSED_MONTHLY` bytesProcessed.monthly. --- ### CfnFederatedSettingsIdentityProviderPropsProtocol Identity provider protocol. #### Members | **Name** | **Description** | | --- | --- | | SAML | SAML. | | OIDC | OIDC. | --- ##### `SAML` SAML. --- ##### `OIDC` OIDC. --- ### CfnOnlineArchivePropsCollectionType Classification of MongoDB database collection that you want to return. If you set this parameter to `TIMESERIES`, set `"criteria.type" : "date"` and `"criteria.dateFormat" : "ISODATE"`. #### Members | **Name** | **Description** | | --- | --- | | STANDARD | STANDARD. | | TIMESERIES | TIMESERIES. | --- ##### `STANDARD` STANDARD. --- ##### `TIMESERIES` TIMESERIES. --- ### CfnOrgInvitationPropsRoles #### Members | **Name** | **Description** | | --- | --- | | ORG_OWNER | ORG_OWNER. | | ORG_MEMBER | ORG_MEMBER. | | ORG_GROUP_CREATOR | ORG_GROUP_CREATOR. | | ORG_BILLING_ADMIN | ORG_BILLING_ADMIN. | | ORG_READ_ONLY | ORG_READ_ONLY. | | GROUP_CLUSTER_MANAGER | GROUP_CLUSTER_MANAGER. | | GROUP_DATA_ACCESS_ADMIN | GROUP_DATA_ACCESS_ADMIN. | | GROUP_DATA_ACCESS_READ_ONLY | GROUP_DATA_ACCESS_READ_ONLY. | | GROUP_DATA_ACCESS_READ_WRITE | GROUP_DATA_ACCESS_READ_WRITE. | | GROUP_OWNER | GROUP_OWNER. | | GROUP_READ_ONLY | GROUP_READ_ONLY. | --- ##### `ORG_OWNER` ORG_OWNER. --- ##### `ORG_MEMBER` ORG_MEMBER. --- ##### `ORG_GROUP_CREATOR` ORG_GROUP_CREATOR. --- ##### `ORG_BILLING_ADMIN` ORG_BILLING_ADMIN. --- ##### `ORG_READ_ONLY` ORG_READ_ONLY. --- ##### `GROUP_CLUSTER_MANAGER` GROUP_CLUSTER_MANAGER. --- ##### `GROUP_DATA_ACCESS_ADMIN` GROUP_DATA_ACCESS_ADMIN. --- ##### `GROUP_DATA_ACCESS_READ_ONLY` GROUP_DATA_ACCESS_READ_ONLY. --- ##### `GROUP_DATA_ACCESS_READ_WRITE` GROUP_DATA_ACCESS_READ_WRITE. --- ##### `GROUP_OWNER` GROUP_OWNER. --- ##### `GROUP_READ_ONLY` GROUP_READ_ONLY. --- ### CfnPrivateEndpointServicePropsCloudProvider Cloud service provider that manages this private endpoint, default : AWS. #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | | AZURE | AZURE. | | GCP | GCP. | --- ##### `AWS` AWS. --- ##### `AZURE` AZURE. --- ##### `GCP` GCP. --- ### CfnProjectInvitationPropsRoles #### Members | **Name** | **Description** | | --- | --- | | GROUP_CLUSTER_MANAGER | GROUP_CLUSTER_MANAGER. | | GROUP_DATA_ACCESS_ADMIN | GROUP_DATA_ACCESS_ADMIN. | | GROUP_DATA_ACCESS_READ_ONLY | GROUP_DATA_ACCESS_READ_ONLY. | | GROUP_DATA_ACCESS_READ_WRITE | GROUP_DATA_ACCESS_READ_WRITE. | | GROUP_OWNER | GROUP_OWNER. | | GROUP_READ_ONLY | GROUP_READ_ONLY. | --- ##### `GROUP_CLUSTER_MANAGER` GROUP_CLUSTER_MANAGER. --- ##### `GROUP_DATA_ACCESS_ADMIN` GROUP_DATA_ACCESS_ADMIN. --- ##### `GROUP_DATA_ACCESS_READ_ONLY` GROUP_DATA_ACCESS_READ_ONLY. --- ##### `GROUP_DATA_ACCESS_READ_WRITE` GROUP_DATA_ACCESS_READ_WRITE. --- ##### `GROUP_OWNER` GROUP_OWNER. --- ##### `GROUP_READ_ONLY` GROUP_READ_ONLY. --- ### CfnStreamConnectionPropsType Type of the connection. Can be Cluster, Kafka, Sample, AWSLambda, or Https. #### Members | **Name** | **Description** | | --- | --- | | KAFKA | Kafka. | | CLUSTER | Cluster. | | SAMPLE | Sample. | | AWS_LAMBDA | AWSLambda. | | HTTPS | Https. | --- ##### `KAFKA` Kafka. --- ##### `CLUSTER` Cluster. --- ##### `SAMPLE` Sample. --- ##### `AWS_LAMBDA` AWSLambda. --- ##### `HTTPS` Https. --- ### CfnStreamProcessorPropsDesiredState The desired state of the stream processor. Used to start or stop the Stream Processor. Valid values are CREATED, STARTED or STOPPED. When a Stream Processor is created without specifying the desired state, it will default to CREATED state. When a Stream Processor is updated without specifying the desired state, it will default to the Previous state. **NOTE** When a Stream Processor is updated without specifying the desired state, it is stopped and then restored to previous state upon update completion. #### Members | **Name** | **Description** | | --- | --- | | CREATED | CREATED. | | STARTED | STARTED. | | STOPPED | STOPPED. | --- ##### `CREATED` CREATED. --- ##### `STARTED` STARTED. --- ##### `STOPPED` STOPPED. --- ### CfnTeamsPropsRoleNames #### Members | **Name** | **Description** | | --- | --- | | GROUP_CLUSTER_MANAGER | GROUP_CLUSTER_MANAGER. | | GROUP_DATA_ACCESS_ADMIN | GROUP_DATA_ACCESS_ADMIN. | | GROUP_DATA_ACCESS_READ_ONLY | GROUP_DATA_ACCESS_READ_ONLY. | | GROUP_DATA_ACCESS_READ_WRITE | GROUP_DATA_ACCESS_READ_WRITE. | | GROUP_OWNER | GROUP_OWNER. | | GROUP_READ_ONLY | GROUP_READ_ONLY. | --- ##### `GROUP_CLUSTER_MANAGER` GROUP_CLUSTER_MANAGER. --- ##### `GROUP_DATA_ACCESS_ADMIN` GROUP_DATA_ACCESS_ADMIN. --- ##### `GROUP_DATA_ACCESS_READ_ONLY` GROUP_DATA_ACCESS_READ_ONLY. --- ##### `GROUP_DATA_ACCESS_READ_WRITE` GROUP_DATA_ACCESS_READ_WRITE. --- ##### `GROUP_OWNER` GROUP_OWNER. --- ##### `GROUP_READ_ONLY` GROUP_READ_ONLY. --- ### CfnThirdPartyIntegrationPropsServiceDiscovery Desired method to discover the Prometheus service. #### Members | **Name** | **Description** | | --- | --- | | HTTP | http. | | FILE | file. | --- ##### `HTTP` http. --- ##### `FILE` file. --- ### CfnThirdPartyIntegrationPropsType Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. #### Members | **Name** | **Description** | | --- | --- | | PAGER_DUTY | PAGER_DUTY. | | MICROSOFT_TEAMS | MICROSOFT_TEAMS. | | SLACK | SLACK. | | DATADOG | DATADOG. | | OPS_GENIE | OPS_GENIE. | | VICTOR_OPS | VICTOR_OPS. | | WEBHOOK | WEBHOOK. | | PROMETHEUS | PROMETHEUS. | --- ##### `PAGER_DUTY` PAGER_DUTY. --- ##### `MICROSOFT_TEAMS` MICROSOFT_TEAMS. --- ##### `SLACK` SLACK. --- ##### `DATADOG` DATADOG. --- ##### `OPS_GENIE` OPS_GENIE. --- ##### `VICTOR_OPS` VICTOR_OPS. --- ##### `WEBHOOK` WEBHOOK. --- ##### `PROMETHEUS` PROMETHEUS. --- ### CriteriaViewDateFormat Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES". #### Members | **Name** | **Description** | | --- | --- | | ISODATE | ISODATE. | | EPOCH_SECONDS | EPOCH_SECONDS. | | EPOCH_MILLIS | EPOCH_MILLIS. | | EPOCH_NANOSECONDS | EPOCH_NANOSECONDS. | --- ##### `ISODATE` ISODATE. --- ##### `EPOCH_SECONDS` EPOCH_SECONDS. --- ##### `EPOCH_MILLIS` EPOCH_MILLIS. --- ##### `EPOCH_NANOSECONDS` EPOCH_NANOSECONDS. --- ### CriteriaViewType Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. (if DATE is selected, the PartitionFields.FieldName must be completed with the Criteria.DateField value)**CUSTOM** selects documents to archive based on a custom JSON query (When selecting this option, the Query property must be inputted). MongoDB Cloud doesn't support **CUSTOM** when `collectionType: TIMESERIES`. #### Members | **Name** | **Description** | | --- | --- | | DATE | DATE. | | CUSTOM | CUSTOM. | --- ##### `DATE` DATE. --- ##### `CUSTOM` CUSTOM. --- ### DatabaseConfigOperationTypes #### Members | **Name** | **Description** | | --- | --- | | INSERT | INSERT. | | UPDATE | UPDATE. | | REPLACE | REPLACE. | | DELETE | DELETE. | --- ##### `INSERT` INSERT. --- ##### `UPDATE` UPDATE. --- ##### `REPLACE` REPLACE. --- ##### `DELETE` DELETE. --- ### DatadogRegion #### Members | **Name** | **Description** | | --- | --- | | US | *No description.* | | EU | *No description.* | | US3 | *No description.* | | US5 | *No description.* | --- ##### `US` --- ##### `EU` --- ##### `US3` --- ##### `US5` --- ### DbRoleToExecuteType Type of the DB role. Can be either BuiltIn or Custom. #### Members | **Name** | **Description** | | --- | --- | | BUILT_IN | BUILT_IN. | | CUSTOM | CUSTOM. | --- ##### `BUILT_IN` BUILT_IN. --- ##### `CUSTOM` CUSTOM. --- ### FilterCloudProvider #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | | AZURE | AZURE. | | GCP | GCP. | --- ##### `AWS` AWS. --- ##### `AZURE` AZURE. --- ##### `GCP` GCP. --- ### IntegerThresholdViewOperator Comparison operator to apply when checking the current metric value. #### Members | **Name** | **Description** | | --- | --- | | GREATER_THAN | GREATER_THAN. | | LESS_THAN | LESS_THAN. | --- ##### `GREATER_THAN` GREATER_THAN. --- ##### `LESS_THAN` LESS_THAN. --- ### MatcherFieldName Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. #### Members | **Name** | **Description** | | --- | --- | | CLUSTER_NAME | CLUSTER_NAME. | | HOSTNAME | HOSTNAME. | | HOSTNAME_AND_PORT | HOSTNAME_AND_PORT. | | PORT | PORT. | | REPLICA_SET_NAME | REPLICA_SET_NAME. | | SHARD_NAME | SHARD_NAME. | | TYPE_NAME | TYPE_NAME. | | APPLICATION_ID | APPLICATION_ID. | | INSTANCE_NAME | INSTANCE_NAME. | | PROCESSOR_NAME | PROCESSOR_NAME. | --- ##### `CLUSTER_NAME` CLUSTER_NAME. --- ##### `HOSTNAME` HOSTNAME. --- ##### `HOSTNAME_AND_PORT` HOSTNAME_AND_PORT. --- ##### `PORT` PORT. --- ##### `REPLICA_SET_NAME` REPLICA_SET_NAME. --- ##### `SHARD_NAME` SHARD_NAME. --- ##### `TYPE_NAME` TYPE_NAME. --- ##### `APPLICATION_ID` APPLICATION_ID. --- ##### `INSTANCE_NAME` INSTANCE_NAME. --- ##### `PROCESSOR_NAME` PROCESSOR_NAME. --- ### MatcherOperator Comparison operator to apply when checking the current metric value against **matcher[n].value**. #### Members | **Name** | **Description** | | --- | --- | | EQUALS | EQUALS. | | CONTAINS | CONTAINS. | | STARTS_WITH | STARTS_WITH. | | ENDS_WITH | ENDS_WITH. | | NOT_EQUALS | NOT_EQUALS. | | NOT_CONTAINS | NOT_CONTAINS. | | REGEX | REGEX. | --- ##### `EQUALS` EQUALS. --- ##### `CONTAINS` CONTAINS. --- ##### `STARTS_WITH` STARTS_WITH. --- ##### `ENDS_WITH` ENDS_WITH. --- ##### `NOT_EQUALS` NOT_EQUALS. --- ##### `NOT_CONTAINS` NOT_CONTAINS. --- ##### `REGEX` REGEX. --- ### MetricThresholdViewMode MongoDB Cloud computes the current metric value as an average. #### Members | **Name** | **Description** | | --- | --- | | AVERAGE | AVERAGE. | --- ##### `AVERAGE` AVERAGE. --- ### MetricThresholdViewOperator Comparison operator to apply when checking the current metric value. #### Members | **Name** | **Description** | | --- | --- | | GREATER_THAN | GREATER_THAN. | | LESS_THAN | LESS_THAN. | --- ##### `GREATER_THAN` GREATER_THAN. --- ##### `LESS_THAN` LESS_THAN. --- ### NotificationViewDatadogRegion Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when '"notifications.typeName" : "DATADOG"'. #### Members | **Name** | **Description** | | --- | --- | | EU | EU. | | US | US. | --- ##### `EU` EU. --- ##### `US` US. --- ### NotificationViewOpsGenieRegion Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. #### Members | **Name** | **Description** | | --- | --- | | EU | EU. | | US | US. | --- ##### `EU` EU. --- ##### `US` US. --- ### NotificationViewRoles #### Members | **Name** | **Description** | | --- | --- | | GROUP_CLUSTER_MANAGER | GROUP_CLUSTER_MANAGER. | | GROUP_DATA_ACCESS_ADMIN | GROUP_DATA_ACCESS_ADMIN. | | GROUP_DATA_ACCESS_READ_ONLY | GROUP_DATA_ACCESS_READ_ONLY. | | GROUP_DATA_ACCESS_READ_WRITE | GROUP_DATA_ACCESS_READ_WRITE. | | GROUP_OWNER | GROUP_OWNER. | | GROUP_READ_WRITE | GROUP_READ_WRITE. | | ORG_OWNER | ORG_OWNER. | | ORG_MEMBER | ORG_MEMBER. | | ORG_GROUP_CREATOR | ORG_GROUP_CREATOR. | | ORG_BILLING_ADMIN | ORG_BILLING_ADMIN. | | ORG_READ_ONLY | ORG_READ_ONLY. | --- ##### `GROUP_CLUSTER_MANAGER` GROUP_CLUSTER_MANAGER. --- ##### `GROUP_DATA_ACCESS_ADMIN` GROUP_DATA_ACCESS_ADMIN. --- ##### `GROUP_DATA_ACCESS_READ_ONLY` GROUP_DATA_ACCESS_READ_ONLY. --- ##### `GROUP_DATA_ACCESS_READ_WRITE` GROUP_DATA_ACCESS_READ_WRITE. --- ##### `GROUP_OWNER` GROUP_OWNER. --- ##### `GROUP_READ_WRITE` GROUP_READ_WRITE. --- ##### `ORG_OWNER` ORG_OWNER. --- ##### `ORG_MEMBER` ORG_MEMBER. --- ##### `ORG_GROUP_CREATOR` ORG_GROUP_CREATOR. --- ##### `ORG_BILLING_ADMIN` ORG_BILLING_ADMIN. --- ##### `ORG_READ_ONLY` ORG_READ_ONLY. --- ### NotificationViewSeverity Degree of seriousness given to this notification. #### Members | **Name** | **Description** | | --- | --- | | CRITICAL | CRITICAL. | | ERROR | ERROR. | | WARNING | WARNING. | --- ##### `CRITICAL` CRITICAL. --- ##### `ERROR` ERROR. --- ##### `WARNING` WARNING. --- ### NotificationViewTypeName Human-readable label that displays the alert notification type. #### Members | **Name** | **Description** | | --- | --- | | DATADOG | DATADOG. | | EMAIL | EMAIL. | | FLOWDOCK | FLOWDOCK. | | GROUP | GROUP. | | MICROSOFT_TEAMS | MICROSOFT_TEAMS. | | OPS_GENIE | OPS_GENIE. | | ORG | ORG. | | PAGER_DUTY | PAGER_DUTY. | | PROMETHEUS | PROMETHEUS. | | SLACK | SLACK. | | SMS | SMS. | | TEAM | TEAM. | | USER | USER. | | VICTOR_OPS | VICTOR_OPS. | | WEBHOOK | WEBHOOK. | --- ##### `DATADOG` DATADOG. --- ##### `EMAIL` EMAIL. --- ##### `FLOWDOCK` FLOWDOCK. --- ##### `GROUP` GROUP. --- ##### `MICROSOFT_TEAMS` MICROSOFT_TEAMS. --- ##### `OPS_GENIE` OPS_GENIE. --- ##### `ORG` ORG. --- ##### `PAGER_DUTY` PAGER_DUTY. --- ##### `PROMETHEUS` PROMETHEUS. --- ##### `SLACK` SLACK. --- ##### `SMS` SMS. --- ##### `TEAM` TEAM. --- ##### `USER` USER. --- ##### `VICTOR_OPS` VICTOR_OPS. --- ##### `WEBHOOK` WEBHOOK. --- ### OnDemandPolicyItemRetentionUnit Unit of time in which MongoDB Cloud measures snapshot retention. Required when OnDemandPolicyItem is provided. #### Members | **Name** | **Description** | | --- | --- | | DAYS | days. | | WEEKS | weeks. | | MONTHS | months. | | YEARS | years. | --- ##### `DAYS` days. --- ##### `WEEKS` weeks. --- ##### `MONTHS` months. --- ##### `YEARS` years. --- ### PagerDutyRegion #### Members | **Name** | **Description** | | --- | --- | | US | *No description.* | | EU | *No description.* | --- ##### `US` --- ##### `EU` --- ### ScheduledPolicyItemRetentionUnit Unit of time in which MongoDB Cloud measures snapshot retention. Required when the policy item is provided. #### Members | **Name** | **Description** | | --- | --- | | DAYS | days. | | WEEKS | weeks. | | MONTHS | months. | | YEARS | years. | --- ##### `DAYS` days. --- ##### `WEEKS` weeks. --- ##### `MONTHS` months. --- ##### `YEARS` years. --- ### ScheduleViewType #### Members | **Name** | **Description** | | --- | --- | | DAILY | DAILY. | | MONTHLY | MONTHLY. | | DEFAULT | DEFAULT. | | WEEKLY | WEEKLY. | --- ##### `DAILY` DAILY. --- ##### `MONTHLY` MONTHLY. --- ##### `DEFAULT` DEFAULT. --- ##### `WEEKLY` WEEKLY. --- ### ScopeDefinitionType #### Members | **Name** | **Description** | | --- | --- | | CLUSTER | CLUSTER. | | DATA_LAKE | DATA_LAKE. | --- ##### `CLUSTER` CLUSTER. --- ##### `DATA_LAKE` DATA_LAKE. --- ### StreamsConnectionType Type of the connection. Can be either Cluster or Kafka. #### Members | **Name** | **Description** | | --- | --- | | KAFKA | Kafka. | | CLUSTER | Cluster. | | SAMPLE | Sample. | --- ##### `KAFKA` Kafka. --- ##### `CLUSTER` Cluster. --- ##### `SAMPLE` Sample. --- ### StreamsDataProcessRegionCloudProvider Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. For CloudFormation, this is restricted to AWS only. #### Members | **Name** | **Description** | | --- | --- | | AWS | AWS. | --- ##### `AWS` AWS. ---