{ "author": { "name": "MongoDB", "roles": [ "author" ], "url": "https://www.mongodb.com/" }, "dependencies": { "aws-cdk-lib": "^2.103.0", "constructs": "^10.0.5" }, "dependencyClosure": { "@aws-cdk/asset-awscli-v1": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.AwsCliV1", "packageId": "Amazon.CDK.Asset.AwsCliV1" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-awscli-go", "packageName": "awscliv1" }, "java": { "maven": { "artifactId": "cdk-asset-awscli-v1", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.awscli.v1" }, "js": { "npm": "@aws-cdk/asset-awscli-v1" }, "python": { "distName": "aws-cdk.asset-awscli-v1", "module": "aws_cdk.asset_awscli_v1" } } }, "@aws-cdk/asset-kubectl-v20": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.KubectlV20", "packageId": "Amazon.CDK.Asset.KubectlV20" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go", "packageName": "kubectlv20" }, "java": { "maven": { "artifactId": "cdk-asset-kubectl-v20", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.kubectl.v20" }, "js": { "npm": "@aws-cdk/asset-kubectl-v20" }, "python": { "distName": "aws-cdk.asset-kubectl-v20", "module": "aws_cdk.asset_kubectl_v20" } } }, "@aws-cdk/asset-node-proxy-agent-v6": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.NodeProxyAgentV6", "packageId": "Amazon.CDK.Asset.NodeProxyAgentV6" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go", "packageName": "nodeproxyagentv6" }, "java": { "maven": { "artifactId": "cdk-asset-node-proxy-agent-v6", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v6" }, "js": { "npm": "@aws-cdk/asset-node-proxy-agent-v6" }, "python": { "distName": "aws-cdk.asset-node-proxy-agent-v6", "module": "aws_cdk.asset_node_proxy_agent_v6" } } }, "aws-cdk-lib": { "submodules": { "aws-cdk-lib.alexa_ask": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Alexa.Ask" }, "java": { "package": "software.amazon.awscdk.alexa.ask" }, "python": { "module": "aws_cdk.alexa_ask" } } }, "aws-cdk-lib.assertions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assertions" }, "java": { "package": "software.amazon.awscdk.assertions" }, "python": { "module": "aws_cdk.assertions" } } }, "aws-cdk-lib.assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assets" }, "java": { "package": "software.amazon.awscdk.assets" }, "python": { "module": "aws_cdk.assets" } } }, "aws-cdk-lib.aws_accessanalyzer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AccessAnalyzer" }, "java": { "package": "software.amazon.awscdk.services.accessanalyzer" }, "python": { "module": "aws_cdk.aws_accessanalyzer" } } }, "aws-cdk-lib.aws_acmpca": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ACMPCA" }, "java": { "package": "software.amazon.awscdk.services.acmpca" }, "python": { "module": "aws_cdk.aws_acmpca" } } }, "aws-cdk-lib.aws_amazonmq": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmazonMQ" }, "java": { "package": "software.amazon.awscdk.services.amazonmq" }, "python": { "module": "aws_cdk.aws_amazonmq" } } }, "aws-cdk-lib.aws_amplify": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Amplify" }, "java": { "package": "software.amazon.awscdk.services.amplify" }, "python": { "module": "aws_cdk.aws_amplify" } } }, "aws-cdk-lib.aws_amplifyuibuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmplifyUIBuilder" }, "java": { "package": "software.amazon.awscdk.services.amplifyuibuilder" }, "python": { "module": "aws_cdk.aws_amplifyuibuilder" } } }, "aws-cdk-lib.aws_apigateway": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APIGateway" }, "java": { "package": "software.amazon.awscdk.services.apigateway" }, "python": { "module": "aws_cdk.aws_apigateway" } } }, "aws-cdk-lib.aws_apigatewayv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Apigatewayv2" }, "java": { "package": "software.amazon.awscdk.services.apigatewayv2" }, "python": { "module": "aws_cdk.aws_apigatewayv2" } } }, "aws-cdk-lib.aws_appconfig": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppConfig" }, "java": { "package": "software.amazon.awscdk.services.appconfig" }, "python": { "module": "aws_cdk.aws_appconfig" } } }, "aws-cdk-lib.aws_appflow": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppFlow" }, "java": { "package": "software.amazon.awscdk.services.appflow" }, "python": { "module": "aws_cdk.aws_appflow" } } }, "aws-cdk-lib.aws_appintegrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppIntegrations" }, "java": { "package": "software.amazon.awscdk.services.appintegrations" }, "python": { "module": "aws_cdk.aws_appintegrations" } } }, "aws-cdk-lib.aws_applicationautoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "package": "software.amazon.awscdk.services.applicationautoscaling" }, "python": { "module": "aws_cdk.aws_applicationautoscaling" } } }, "aws-cdk-lib.aws_applicationinsights": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationInsights" }, "java": { "package": "software.amazon.awscdk.services.applicationinsights" }, "python": { "module": "aws_cdk.aws_applicationinsights" } } }, "aws-cdk-lib.aws_appmesh": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppMesh" }, "java": { "package": "software.amazon.awscdk.services.appmesh" }, "python": { "module": "aws_cdk.aws_appmesh" } } }, "aws-cdk-lib.aws_apprunner": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppRunner" }, "java": { "package": "software.amazon.awscdk.services.apprunner" }, "python": { "module": "aws_cdk.aws_apprunner" } } }, "aws-cdk-lib.aws_appstream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppStream" }, "java": { "package": "software.amazon.awscdk.services.appstream" }, "python": { "module": "aws_cdk.aws_appstream" } } }, "aws-cdk-lib.aws_appsync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppSync" }, "java": { "package": "software.amazon.awscdk.services.appsync" }, "python": { "module": "aws_cdk.aws_appsync" } } }, "aws-cdk-lib.aws_aps": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APS" }, "java": { "package": "software.amazon.awscdk.services.aps" }, "python": { "module": "aws_cdk.aws_aps" } } }, "aws-cdk-lib.aws_athena": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Athena" }, "java": { "package": "software.amazon.awscdk.services.athena" }, "python": { "module": "aws_cdk.aws_athena" } } }, "aws-cdk-lib.aws_auditmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AuditManager" }, "java": { "package": "software.amazon.awscdk.services.auditmanager" }, "python": { "module": "aws_cdk.aws_auditmanager" } } }, "aws-cdk-lib.aws_autoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling" }, "java": { "package": "software.amazon.awscdk.services.autoscaling" }, "python": { "module": "aws_cdk.aws_autoscaling" } } }, "aws-cdk-lib.aws_autoscaling_common": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.common" }, "python": { "module": "aws_cdk.aws_autoscaling_common" } } }, "aws-cdk-lib.aws_autoscaling_hooktargets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.hooktargets" }, "python": { "module": "aws_cdk.aws_autoscaling_hooktargets" } } }, "aws-cdk-lib.aws_autoscalingplans": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScalingPlans" }, "java": { "package": "software.amazon.awscdk.services.autoscalingplans" }, "python": { "module": "aws_cdk.aws_autoscalingplans" } } }, "aws-cdk-lib.aws_backup": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Backup" }, "java": { "package": "software.amazon.awscdk.services.backup" }, "python": { "module": "aws_cdk.aws_backup" } } }, "aws-cdk-lib.aws_backupgateway": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BackupGateway" }, "java": { "package": "services.backupgateway" }, "python": { "module": "aws_cdk.aws_backupgateway" } } }, "aws-cdk-lib.aws_batch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Batch" }, "java": { "package": "software.amazon.awscdk.services.batch" }, "python": { "module": "aws_cdk.aws_batch" } } }, "aws-cdk-lib.aws_billingconductor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.BillingConductor" }, "java": { "package": "software.amazon.awscdk.services.billingconductor" }, "python": { "module": "aws_cdk.aws_billingconductor" } } }, "aws-cdk-lib.aws_budgets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Budgets" }, "java": { "package": "software.amazon.awscdk.services.budgets" }, "python": { "module": "aws_cdk.aws_budgets" } } }, "aws-cdk-lib.aws_cassandra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cassandra" }, "java": { "package": "software.amazon.awscdk.services.cassandra" }, "python": { "module": "aws_cdk.aws_cassandra" } } }, "aws-cdk-lib.aws_ce": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CE" }, "java": { "package": "software.amazon.awscdk.services.ce" }, "python": { "module": "aws_cdk.aws_ce" } } }, "aws-cdk-lib.aws_certificatemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CertificateManager" }, "java": { "package": "software.amazon.awscdk.services.certificatemanager" }, "python": { "module": "aws_cdk.aws_certificatemanager" } } }, "aws-cdk-lib.aws_chatbot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Chatbot" }, "java": { "package": "software.amazon.awscdk.services.chatbot" }, "python": { "module": "aws_cdk.aws_chatbot" } } }, "aws-cdk-lib.aws_cleanrooms": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRooms" }, "java": { "package": "services.cleanrooms" }, "python": { "module": "aws_cdk.aws_cleanrooms" } } }, "aws-cdk-lib.aws_cloud9": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cloud9" }, "java": { "package": "software.amazon.awscdk.services.cloud9" }, "python": { "module": "aws_cdk.aws_cloud9" } } }, "aws-cdk-lib.aws_cloudformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFormation" }, "java": { "package": "software.amazon.awscdk.services.cloudformation" }, "python": { "module": "aws_cdk.aws_cloudformation" } } }, "aws-cdk-lib.aws_cloudfront": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront" }, "java": { "package": "software.amazon.awscdk.services.cloudfront" }, "python": { "module": "aws_cdk.aws_cloudfront" } } }, "aws-cdk-lib.aws_cloudfront.experimental": {}, "aws-cdk-lib.aws_cloudfront_origins": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront.Origins" }, "java": { "package": "software.amazon.awscdk.services.cloudfront.origins" }, "python": { "module": "aws_cdk.aws_cloudfront_origins" } } }, "aws-cdk-lib.aws_cloudtrail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudTrail" }, "java": { "package": "software.amazon.awscdk.services.cloudtrail" }, "python": { "module": "aws_cdk.aws_cloudtrail" } } }, "aws-cdk-lib.aws_cloudwatch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch" }, "python": { "module": "aws_cdk.aws_cloudwatch" } } }, "aws-cdk-lib.aws_cloudwatch_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch.Actions" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch.actions" }, "python": { "module": "aws_cdk.aws_cloudwatch_actions" } } }, "aws-cdk-lib.aws_codeartifact": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeArtifact" }, "java": { "package": "software.amazon.awscdk.services.codeartifact" }, "python": { "module": "aws_cdk.aws_codeartifact" } } }, "aws-cdk-lib.aws_codebuild": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeBuild" }, "java": { "package": "software.amazon.awscdk.services.codebuild" }, "python": { "module": "aws_cdk.aws_codebuild" } } }, "aws-cdk-lib.aws_codecommit": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeCommit" }, "java": { "package": "software.amazon.awscdk.services.codecommit" }, "python": { "module": "aws_cdk.aws_codecommit" } } }, "aws-cdk-lib.aws_codedeploy": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeDeploy" }, "java": { "package": "software.amazon.awscdk.services.codedeploy" }, "python": { "module": "aws_cdk.aws_codedeploy" } } }, "aws-cdk-lib.aws_codeguruprofiler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "package": "software.amazon.awscdk.services.codeguruprofiler" }, "python": { "module": "aws_cdk.aws_codeguruprofiler" } } }, "aws-cdk-lib.aws_codegurureviewer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruReviewer" }, "java": { "package": "software.amazon.awscdk.services.codegurureviewer" }, "python": { "module": "aws_cdk.aws_codegurureviewer" } } }, "aws-cdk-lib.aws_codepipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline" }, "java": { "package": "software.amazon.awscdk.services.codepipeline" }, "python": { "module": "aws_cdk.aws_codepipeline" } } }, "aws-cdk-lib.aws_codepipeline_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline.Actions" }, "java": { "package": "software.amazon.awscdk.services.codepipeline.actions" }, "python": { "module": "aws_cdk.aws_codepipeline_actions" } } }, "aws-cdk-lib.aws_codestar": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Codestar" }, "java": { "package": "software.amazon.awscdk.services.codestar" }, "python": { "module": "aws_cdk.aws_codestar" } } }, "aws-cdk-lib.aws_codestarconnections": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarConnections" }, "java": { "package": "software.amazon.awscdk.services.codestarconnections" }, "python": { "module": "aws_cdk.aws_codestarconnections" } } }, "aws-cdk-lib.aws_codestarnotifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "package": "software.amazon.awscdk.services.codestarnotifications" }, "python": { "module": "aws_cdk.aws_codestarnotifications" } } }, "aws-cdk-lib.aws_cognito": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cognito" }, "java": { "package": "software.amazon.awscdk.services.cognito" }, "python": { "module": "aws_cdk.aws_cognito" } } }, "aws-cdk-lib.aws_comprehend": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Comprehend" }, "java": { "package": "software.amazon.awscdk.services.comprehend" }, "python": { "module": "aws_cdk.aws_comprehend" } } }, "aws-cdk-lib.aws_config": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Config" }, "java": { "package": "software.amazon.awscdk.services.config" }, "python": { "module": "aws_cdk.aws_config" } } }, "aws-cdk-lib.aws_connect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Connect" }, "java": { "package": "software.amazon.awscdk.services.connect" }, "python": { "module": "aws_cdk.aws_connect" } } }, "aws-cdk-lib.aws_connectcampaigns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ConnectCampaigns" }, "java": { "package": "software.amazon.awscdk.services.connectcampaigns" }, "python": { "module": "aws_cdk.aws_connectcampaigns" } } }, "aws-cdk-lib.aws_controltower": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ControlTower" }, "java": { "package": "software.amazon.awscdk.services.controltower" }, "python": { "module": "aws_cdk.aws_controltower" } } }, "aws-cdk-lib.aws_cur": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CUR" }, "java": { "package": "software.amazon.awscdk.services.cur" }, "python": { "module": "aws_cdk.aws_cur" } } }, "aws-cdk-lib.aws_customerprofiles": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CustomerProfiles" }, "java": { "package": "software.amazon.awscdk.services.customerprofiles" }, "python": { "module": "aws_cdk.aws_customerprofiles" } } }, "aws-cdk-lib.aws_databrew": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataBrew" }, "java": { "package": "software.amazon.awscdk.services.databrew" }, "python": { "module": "aws_cdk.aws_databrew" } } }, "aws-cdk-lib.aws_datapipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataPipeline" }, "java": { "package": "software.amazon.awscdk.services.datapipeline" }, "python": { "module": "aws_cdk.aws_datapipeline" } } }, "aws-cdk-lib.aws_datasync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataSync" }, "java": { "package": "software.amazon.awscdk.services.datasync" }, "python": { "module": "aws_cdk.aws_datasync" } } }, "aws-cdk-lib.aws_dax": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DAX" }, "java": { "package": "software.amazon.awscdk.services.dax" }, "python": { "module": "aws_cdk.aws_dax" } } }, "aws-cdk-lib.aws_detective": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Detective" }, "java": { "package": "software.amazon.awscdk.services.detective" }, "python": { "module": "aws_cdk.aws_detective" } } }, "aws-cdk-lib.aws_devicefarm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DeviceFarm" }, "java": { "package": "software.amazon.awscdk.services.devicefarm" }, "python": { "module": "aws_cdk.aws_devicefarm" } } }, "aws-cdk-lib.aws_devopsguru": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DevOpsGuru" }, "java": { "package": "software.amazon.awscdk.services.devopsguru" }, "python": { "module": "aws_cdk.aws_devopsguru" } } }, "aws-cdk-lib.aws_directoryservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DirectoryService" }, "java": { "package": "software.amazon.awscdk.services.directoryservice" }, "python": { "module": "aws_cdk.aws_directoryservice" } } }, "aws-cdk-lib.aws_dlm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DLM" }, "java": { "package": "software.amazon.awscdk.services.dlm" }, "python": { "module": "aws_cdk.aws_dlm" } } }, "aws-cdk-lib.aws_dms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DMS" }, "java": { "package": "software.amazon.awscdk.services.dms" }, "python": { "module": "aws_cdk.aws_dms" } } }, "aws-cdk-lib.aws_docdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDB" }, "java": { "package": "software.amazon.awscdk.services.docdb" }, "python": { "module": "aws_cdk.aws_docdb" } } }, "aws-cdk-lib.aws_docdbelastic": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDBElastic" }, "java": { "package": "software.amazon.awscdk.services.docdbelastic" }, "python": { "module": "aws_cdk.aws_docdbelastic" } } }, "aws-cdk-lib.aws_dynamodb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DynamoDB" }, "java": { "package": "software.amazon.awscdk.services.dynamodb" }, "python": { "module": "aws_cdk.aws_dynamodb" } } }, "aws-cdk-lib.aws_ec2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EC2" }, "java": { "package": "software.amazon.awscdk.services.ec2" }, "python": { "module": "aws_cdk.aws_ec2" } } }, "aws-cdk-lib.aws_ecr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECR" }, "java": { "package": "software.amazon.awscdk.services.ecr" }, "python": { "module": "aws_cdk.aws_ecr" } } }, "aws-cdk-lib.aws_ecr_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ecr.Assets" }, "java": { "package": "software.amazon.awscdk.services.ecr.assets" }, "python": { "module": "aws_cdk.aws_ecr_assets" } } }, "aws-cdk-lib.aws_ecs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS" }, "java": { "package": "software.amazon.awscdk.services.ecs" }, "python": { "module": "aws_cdk.aws_ecs" } } }, "aws-cdk-lib.aws_ecs_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS.Patterns" }, "java": { "package": "software.amazon.awscdk.services.ecs.patterns" }, "python": { "module": "aws_cdk.aws_ecs_patterns" } } }, "aws-cdk-lib.aws_efs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EFS" }, "java": { "package": "software.amazon.awscdk.services.efs" }, "python": { "module": "aws_cdk.aws_efs" } } }, "aws-cdk-lib.aws_eks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EKS" }, "java": { "package": "software.amazon.awscdk.services.eks" }, "python": { "module": "aws_cdk.aws_eks" } } }, "aws-cdk-lib.aws_elasticache": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElastiCache" }, "java": { "package": "software.amazon.awscdk.services.elasticache" }, "python": { "module": "aws_cdk.aws_elasticache" } } }, "aws-cdk-lib.aws_elasticbeanstalk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticBeanstalk" }, "java": { "package": "software.amazon.awscdk.services.elasticbeanstalk" }, "python": { "module": "aws_cdk.aws_elasticbeanstalk" } } }, "aws-cdk-lib.aws_elasticloadbalancing": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancing" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancing" }, "python": { "module": "aws_cdk.aws_elasticloadbalancing" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.actions" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_actions" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.targets" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_targets" } } }, "aws-cdk-lib.aws_elasticsearch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Elasticsearch" }, "java": { "package": "software.amazon.awscdk.services.elasticsearch" }, "python": { "module": "aws_cdk.aws_elasticsearch" } } }, "aws-cdk-lib.aws_emr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMR" }, "java": { "package": "software.amazon.awscdk.services.emr" }, "python": { "module": "aws_cdk.aws_emr" } } }, "aws-cdk-lib.aws_emrcontainers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRContainers" }, "java": { "package": "software.amazon.awscdk.services.emrcontainers" }, "python": { "module": "aws_cdk.aws_emrcontainers" } } }, "aws-cdk-lib.aws_emrserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRServerless" }, "java": { "package": "software.amazon.awscdk.services.emrserverless" }, "python": { "module": "aws_cdk.aws_emrserverless" } } }, "aws-cdk-lib.aws_entityresolution": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.EntityResolution" }, "java": { "package": "services.entityresolution" }, "python": { "module": "aws_cdk.aws_entityresolution" } } }, "aws-cdk-lib.aws_events": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events" }, "java": { "package": "software.amazon.awscdk.services.events" }, "python": { "module": "aws_cdk.aws_events" } } }, "aws-cdk-lib.aws_events_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events.Targets" }, "java": { "package": "software.amazon.awscdk.services.events.targets" }, "python": { "module": "aws_cdk.aws_events_targets" } } }, "aws-cdk-lib.aws_eventschemas": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EventSchemas" }, "java": { "package": "software.amazon.awscdk.services.eventschemas" }, "python": { "module": "aws_cdk.aws_eventschemas" } } }, "aws-cdk-lib.aws_evidently": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Evidently" }, "java": { "package": "software.amazon.awscdk.services.evidently" }, "python": { "module": "aws_cdk.aws_evidently" } } }, "aws-cdk-lib.aws_finspace": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FinSpace" }, "java": { "package": "software.amazon.awscdk.services.finspace" }, "python": { "module": "aws_cdk.aws_finspace" } } }, "aws-cdk-lib.aws_fis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FIS" }, "java": { "package": "software.amazon.awscdk.services.fis" }, "python": { "module": "aws_cdk.aws_fis" } } }, "aws-cdk-lib.aws_fms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FMS" }, "java": { "package": "software.amazon.awscdk.services.fms" }, "python": { "module": "aws_cdk.aws_fms" } } }, "aws-cdk-lib.aws_forecast": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Forecast" }, "java": { "package": "software.amazon.awscdk.services.forecast" }, "python": { "module": "aws_cdk.aws_forecast" } } }, "aws-cdk-lib.aws_frauddetector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FraudDetector" }, "java": { "package": "software.amazon.awscdk.services.frauddetector" }, "python": { "module": "aws_cdk.aws_frauddetector" } } }, "aws-cdk-lib.aws_fsx": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FSx" }, "java": { "package": "software.amazon.awscdk.services.fsx" }, "python": { "module": "aws_cdk.aws_fsx" } } }, "aws-cdk-lib.aws_gamelift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GameLift" }, "java": { "package": "software.amazon.awscdk.services.gamelift" }, "python": { "module": "aws_cdk.aws_gamelift" } } }, "aws-cdk-lib.aws_globalaccelerator": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator" }, "python": { "module": "aws_cdk.aws_globalaccelerator" } } }, "aws-cdk-lib.aws_globalaccelerator_endpoints": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator.Endpoints" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator.endpoints" }, "python": { "module": "aws_cdk.aws_globalaccelerator_endpoints" } } }, "aws-cdk-lib.aws_glue": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Glue" }, "java": { "package": "software.amazon.awscdk.services.glue" }, "python": { "module": "aws_cdk.aws_glue" } } }, "aws-cdk-lib.aws_grafana": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Grafana" }, "java": { "package": "software.amazon.awscdk.services.grafana" }, "python": { "module": "aws_cdk.aws_grafana" } } }, "aws-cdk-lib.aws_greengrass": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Greengrass" }, "java": { "package": "software.amazon.awscdk.services.greengrass" }, "python": { "module": "aws_cdk.aws_greengrass" } } }, "aws-cdk-lib.aws_greengrassv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GreengrassV2" }, "java": { "package": "software.amazon.awscdk.services.greengrassv2" }, "python": { "module": "aws_cdk.aws_greengrassv2" } } }, "aws-cdk-lib.aws_groundstation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GroundStation" }, "java": { "package": "software.amazon.awscdk.services.groundstation" }, "python": { "module": "aws_cdk.aws_groundstation" } } }, "aws-cdk-lib.aws_guardduty": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GuardDuty" }, "java": { "package": "software.amazon.awscdk.services.guardduty" }, "python": { "module": "aws_cdk.aws_guardduty" } } }, "aws-cdk-lib.aws_healthimaging": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.HealthImaging" }, "java": { "package": "services.healthimaging" }, "python": { "module": "aws_cdk.aws_healthimaging" } } }, "aws-cdk-lib.aws_healthlake": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.HealthLake" }, "java": { "package": "software.amazon.awscdk.services.healthlake" }, "python": { "module": "aws_cdk.aws_healthlake" } } }, "aws-cdk-lib.aws_iam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IAM" }, "java": { "package": "software.amazon.awscdk.services.iam" }, "python": { "module": "aws_cdk.aws_iam" } } }, "aws-cdk-lib.aws_identitystore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IdentityStore" }, "java": { "package": "software.amazon.awscdk.services.identitystore" }, "python": { "module": "aws_cdk.aws_identitystore" } } }, "aws-cdk-lib.aws_imagebuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ImageBuilder" }, "java": { "package": "software.amazon.awscdk.services.imagebuilder" }, "python": { "module": "aws_cdk.aws_imagebuilder" } } }, "aws-cdk-lib.aws_inspector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Inspector" }, "java": { "package": "software.amazon.awscdk.services.inspector" }, "python": { "module": "aws_cdk.aws_inspector" } } }, "aws-cdk-lib.aws_inspectorv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InspectorV2" }, "java": { "package": "software.amazon.awscdk.services.inspectorv2" }, "python": { "module": "aws_cdk.aws_inspectorv2" } } }, "aws-cdk-lib.aws_internetmonitor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InternetMonitor" }, "java": { "package": "software.amazon.awscdk.services.internetmonitor" }, "python": { "module": "aws_cdk.aws_internetmonitor" } } }, "aws-cdk-lib.aws_iot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT" }, "java": { "package": "software.amazon.awscdk.services.iot" }, "python": { "module": "aws_cdk.aws_iot" } } }, "aws-cdk-lib.aws_iot1click": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT1Click" }, "java": { "package": "software.amazon.awscdk.services.iot1click" }, "python": { "module": "aws_cdk.aws_iot1click" } } }, "aws-cdk-lib.aws_iotanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTAnalytics" }, "java": { "package": "software.amazon.awscdk.services.iotanalytics" }, "python": { "module": "aws_cdk.aws_iotanalytics" } } }, "aws-cdk-lib.aws_iotcoredeviceadvisor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTCoreDeviceAdvisor" }, "java": { "package": "software.amazon.awscdk.services.iotcoredeviceadvisor" }, "python": { "module": "aws_cdk.aws_iotcoredeviceadvisor" } } }, "aws-cdk-lib.aws_iotevents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTEvents" }, "java": { "package": "software.amazon.awscdk.services.iotevents" }, "python": { "module": "aws_cdk.aws_iotevents" } } }, "aws-cdk-lib.aws_iotfleethub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetHub" }, "java": { "package": "software.amazon.awscdk.services.iotfleethub" }, "python": { "module": "aws_cdk.aws_iotfleethub" } } }, "aws-cdk-lib.aws_iotfleetwise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetWise" }, "java": { "package": "software.amazon.awscdk.services.iotfleetwise" }, "python": { "module": "aws_cdk.aws_iotfleetwise" } } }, "aws-cdk-lib.aws_iotsitewise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTSiteWise" }, "java": { "package": "software.amazon.awscdk.services.iotsitewise" }, "python": { "module": "aws_cdk.aws_iotsitewise" } } }, "aws-cdk-lib.aws_iotthingsgraph": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTThingsGraph" }, "java": { "package": "software.amazon.awscdk.services.iotthingsgraph" }, "python": { "module": "aws_cdk.aws_iotthingsgraph" } } }, "aws-cdk-lib.aws_iottwinmaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTTwinMaker" }, "java": { "package": "software.amazon.awscdk.services.iottwinmaker" }, "python": { "module": "aws_cdk.aws_iottwinmaker" } } }, "aws-cdk-lib.aws_iotwireless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTWireless" }, "java": { "package": "software.amazon.awscdk.services.iotwireless" }, "python": { "module": "aws_cdk.aws_iotwireless" } } }, "aws-cdk-lib.aws_ivs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ivs" }, "java": { "package": "software.amazon.awscdk.services.ivs" }, "python": { "module": "aws_cdk.aws_ivs" } } }, "aws-cdk-lib.aws_ivschat": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IVSChat" }, "java": { "package": "software.amazon.awscdk.services.ivschat" }, "python": { "module": "aws_cdk.aws_ivschat" } } }, "aws-cdk-lib.aws_kafkaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KafkaConnect" }, "java": { "package": "software.amazon.awscdk.services.kafkaconnect" }, "python": { "module": "aws_cdk.aws_kafkaconnect" } } }, "aws-cdk-lib.aws_kendra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kendra" }, "java": { "package": "software.amazon.awscdk.services.kendra" }, "python": { "module": "aws_cdk.aws_kendra" } } }, "aws-cdk-lib.aws_kendraranking": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KendraRanking" }, "java": { "package": "software.amazon.awscdk.services.kendraranking" }, "python": { "module": "aws_cdk.aws_kendraranking" } } }, "aws-cdk-lib.aws_kinesis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kinesis" }, "java": { "package": "software.amazon.awscdk.services.kinesis" }, "python": { "module": "aws_cdk.aws_kinesis" } } }, "aws-cdk-lib.aws_kinesisanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalytics" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalytics" }, "python": { "module": "aws_cdk.aws_kinesisanalytics" } } }, "aws-cdk-lib.aws_kinesisanalyticsv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalyticsv2" }, "python": { "module": "aws_cdk.aws_kinesisanalyticsv2" } } }, "aws-cdk-lib.aws_kinesisfirehose": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisFirehose" }, "java": { "package": "software.amazon.awscdk.services.kinesisfirehose" }, "python": { "module": "aws_cdk.aws_kinesisfirehose" } } }, "aws-cdk-lib.aws_kinesisvideo": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisVideo" }, "java": { "package": "software.amazon.awscdk.services.kinesisvideo" }, "python": { "module": "aws_cdk.aws_kinesisvideo" } } }, "aws-cdk-lib.aws_kms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KMS" }, "java": { "package": "software.amazon.awscdk.services.kms" }, "python": { "module": "aws_cdk.aws_kms" } } }, "aws-cdk-lib.aws_lakeformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LakeFormation" }, "java": { "package": "software.amazon.awscdk.services.lakeformation" }, "python": { "module": "aws_cdk.aws_lakeformation" } } }, "aws-cdk-lib.aws_lambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda" }, "java": { "package": "software.amazon.awscdk.services.lambda" }, "python": { "module": "aws_cdk.aws_lambda" } } }, "aws-cdk-lib.aws_lambda_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Destinations" }, "java": { "package": "software.amazon.awscdk.services.lambda.destinations" }, "python": { "module": "aws_cdk.aws_lambda_destinations" } } }, "aws-cdk-lib.aws_lambda_event_sources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.EventSources" }, "java": { "package": "software.amazon.awscdk.services.lambda.eventsources" }, "python": { "module": "aws_cdk.aws_lambda_event_sources" } } }, "aws-cdk-lib.aws_lambda_nodejs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Nodejs" }, "java": { "package": "software.amazon.awscdk.services.lambda.nodejs" }, "python": { "module": "aws_cdk.aws_lambda_nodejs" } } }, "aws-cdk-lib.aws_lex": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lex" }, "java": { "package": "software.amazon.awscdk.services.lex" }, "python": { "module": "aws_cdk.aws_lex" } } }, "aws-cdk-lib.aws_licensemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LicenseManager" }, "java": { "package": "software.amazon.awscdk.services.licensemanager" }, "python": { "module": "aws_cdk.aws_licensemanager" } } }, "aws-cdk-lib.aws_lightsail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lightsail" }, "java": { "package": "software.amazon.awscdk.services.lightsail" }, "python": { "module": "aws_cdk.aws_lightsail" } } }, "aws-cdk-lib.aws_location": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Location" }, "java": { "package": "software.amazon.awscdk.services.location" }, "python": { "module": "aws_cdk.aws_location" } } }, "aws-cdk-lib.aws_logs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs" }, "java": { "package": "software.amazon.awscdk.services.logs" }, "python": { "module": "aws_cdk.aws_logs" } } }, "aws-cdk-lib.aws_logs_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs.Destinations" }, "java": { "package": "software.amazon.awscdk.services.logs.destinations" }, "python": { "module": "aws_cdk.aws_logs_destinations" } } }, "aws-cdk-lib.aws_lookoutequipment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutEquipment" }, "java": { "package": "software.amazon.awscdk.services.lookoutequipment" }, "python": { "module": "aws_cdk.aws_lookoutequipment" } } }, "aws-cdk-lib.aws_lookoutmetrics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutMetrics" }, "java": { "package": "software.amazon.awscdk.services.lookoutmetrics" }, "python": { "module": "aws_cdk.aws_lookoutmetrics" } } }, "aws-cdk-lib.aws_lookoutvision": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutVision" }, "java": { "package": "software.amazon.awscdk.services.lookoutvision" }, "python": { "module": "aws_cdk.aws_lookoutvision" } } }, "aws-cdk-lib.aws_m2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.M2" }, "java": { "package": "software.amazon.awscdk.services.m2" }, "python": { "module": "aws_cdk.aws_m2" } } }, "aws-cdk-lib.aws_macie": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Macie" }, "java": { "package": "software.amazon.awscdk.services.macie" }, "python": { "module": "aws_cdk.aws_macie" } } }, "aws-cdk-lib.aws_managedblockchain": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ManagedBlockchain" }, "java": { "package": "software.amazon.awscdk.services.managedblockchain" }, "python": { "module": "aws_cdk.aws_managedblockchain" } } }, "aws-cdk-lib.aws_mediaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConnect" }, "java": { "package": "software.amazon.awscdk.services.mediaconnect" }, "python": { "module": "aws_cdk.aws_mediaconnect" } } }, "aws-cdk-lib.aws_mediaconvert": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConvert" }, "java": { "package": "software.amazon.awscdk.services.mediaconvert" }, "python": { "module": "aws_cdk.aws_mediaconvert" } } }, "aws-cdk-lib.aws_medialive": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaLive" }, "java": { "package": "software.amazon.awscdk.services.medialive" }, "python": { "module": "aws_cdk.aws_medialive" } } }, "aws-cdk-lib.aws_mediapackage": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaPackage" }, "java": { "package": "software.amazon.awscdk.services.mediapackage" }, "python": { "module": "aws_cdk.aws_mediapackage" } } }, "aws-cdk-lib.aws_mediapackagev2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.MediaPackageV2" }, "java": { "package": "services.mediapackagev2" }, "python": { "module": "aws_cdk.aws_mediapackagev2" } } }, "aws-cdk-lib.aws_mediastore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaStore" }, "java": { "package": "software.amazon.awscdk.services.mediastore" }, "python": { "module": "aws_cdk.aws_mediastore" } } }, "aws-cdk-lib.aws_mediatailor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaTailor" }, "java": { "package": "software.amazon.awscdk.services.mediatailor" }, "python": { "module": "aws_cdk.aws_mediatailor" } } }, "aws-cdk-lib.aws_memorydb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MemoryDB" }, "java": { "package": "software.amazon.awscdk.services.memorydb" }, "python": { "module": "aws_cdk.aws_memorydb" } } }, "aws-cdk-lib.aws_msk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MSK" }, "java": { "package": "software.amazon.awscdk.services.msk" }, "python": { "module": "aws_cdk.aws_msk" } } }, "aws-cdk-lib.aws_mwaa": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MWAA" }, "java": { "package": "software.amazon.awscdk.services.mwaa" }, "python": { "module": "aws_cdk.aws_mwaa" } } }, "aws-cdk-lib.aws_neptune": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Neptune" }, "java": { "package": "software.amazon.awscdk.services.neptune" }, "python": { "module": "aws_cdk.aws_neptune" } } }, "aws-cdk-lib.aws_networkfirewall": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkFirewall" }, "java": { "package": "software.amazon.awscdk.services.networkfirewall" }, "python": { "module": "aws_cdk.aws_networkfirewall" } } }, "aws-cdk-lib.aws_networkmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkManager" }, "java": { "package": "software.amazon.awscdk.services.networkmanager" }, "python": { "module": "aws_cdk.aws_networkmanager" } } }, "aws-cdk-lib.aws_nimblestudio": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NimbleStudio" }, "java": { "package": "software.amazon.awscdk.services.nimblestudio" }, "python": { "module": "aws_cdk.aws_nimblestudio" } } }, "aws-cdk-lib.aws_oam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Oam" }, "java": { "package": "software.amazon.awscdk.services.oam" }, "python": { "module": "aws_cdk.aws_oam" } } }, "aws-cdk-lib.aws_omics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Omics" }, "java": { "package": "software.amazon.awscdk.services.omics" }, "python": { "module": "aws_cdk.aws_omics" } } }, "aws-cdk-lib.aws_opensearchserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchServerless" }, "java": { "package": "software.amazon.awscdk.services.opensearchserverless" }, "python": { "module": "aws_cdk.aws_opensearchserverless" } } }, "aws-cdk-lib.aws_opensearchservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchService" }, "java": { "package": "software.amazon.awscdk.services.opensearchservice" }, "python": { "module": "aws_cdk.aws_opensearchservice" } } }, "aws-cdk-lib.aws_opsworks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorks" }, "java": { "package": "software.amazon.awscdk.services.opsworks" }, "python": { "module": "aws_cdk.aws_opsworks" } } }, "aws-cdk-lib.aws_opsworkscm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorksCM" }, "java": { "package": "software.amazon.awscdk.services.opsworkscm" }, "python": { "module": "aws_cdk.aws_opsworkscm" } } }, "aws-cdk-lib.aws_organizations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Organizations" }, "java": { "package": "software.amazon.awscdk.services.organizations" }, "python": { "module": "aws_cdk.aws_organizations" } } }, "aws-cdk-lib.aws_osis": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.OSIS" }, "java": { "package": "services.osis" }, "python": { "module": "aws_cdk.aws_osis" } } }, "aws-cdk-lib.aws_panorama": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Panorama" }, "java": { "package": "software.amazon.awscdk.services.panorama" }, "python": { "module": "aws_cdk.aws_panorama" } } }, "aws-cdk-lib.aws_pcaconnectorad": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorAD" }, "java": { "package": "services.pcaconnectorad" }, "python": { "module": "aws_cdk.aws_pcaconnectorad" } } }, "aws-cdk-lib.aws_personalize": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Personalize" }, "java": { "package": "software.amazon.awscdk.services.personalize" }, "python": { "module": "aws_cdk.aws_personalize" } } }, "aws-cdk-lib.aws_pinpoint": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pinpoint" }, "java": { "package": "software.amazon.awscdk.services.pinpoint" }, "python": { "module": "aws_cdk.aws_pinpoint" } } }, "aws-cdk-lib.aws_pinpointemail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.PinpointEmail" }, "java": { "package": "software.amazon.awscdk.services.pinpointemail" }, "python": { "module": "aws_cdk.aws_pinpointemail" } } }, "aws-cdk-lib.aws_pipes": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pipes" }, "java": { "package": "software.amazon.awscdk.services.pipes" }, "python": { "module": "aws_cdk.aws_pipes" } } }, "aws-cdk-lib.aws_proton": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Proton" }, "java": { "package": "services.proton" }, "python": { "module": "aws_cdk.aws_proton" } } }, "aws-cdk-lib.aws_qldb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QLDB" }, "java": { "package": "software.amazon.awscdk.services.qldb" }, "python": { "module": "aws_cdk.aws_qldb" } } }, "aws-cdk-lib.aws_quicksight": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QuickSight" }, "java": { "package": "software.amazon.awscdk.services.quicksight" }, "python": { "module": "aws_cdk.aws_quicksight" } } }, "aws-cdk-lib.aws_ram": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RAM" }, "java": { "package": "software.amazon.awscdk.services.ram" }, "python": { "module": "aws_cdk.aws_ram" } } }, "aws-cdk-lib.aws_rds": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RDS" }, "java": { "package": "software.amazon.awscdk.services.rds" }, "python": { "module": "aws_cdk.aws_rds" } } }, "aws-cdk-lib.aws_redshift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Redshift" }, "java": { "package": "software.amazon.awscdk.services.redshift" }, "python": { "module": "aws_cdk.aws_redshift" } } }, "aws-cdk-lib.aws_redshiftserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RedshiftServerless" }, "java": { "package": "software.amazon.awscdk.services.redshiftserverless" }, "python": { "module": "aws_cdk.aws_redshiftserverless" } } }, "aws-cdk-lib.aws_refactorspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RefactorSpaces" }, "java": { "package": "software.amazon.awscdk.services.refactorspaces" }, "python": { "module": "aws_cdk.aws_refactorspaces" } } }, "aws-cdk-lib.aws_rekognition": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Rekognition" }, "java": { "package": "software.amazon.awscdk.services.rekognition" }, "python": { "module": "aws_cdk.aws_rekognition" } } }, "aws-cdk-lib.aws_resiliencehub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResilienceHub" }, "java": { "package": "software.amazon.awscdk.services.resiliencehub" }, "python": { "module": "aws_cdk.aws_resiliencehub" } } }, "aws-cdk-lib.aws_resourceexplorer2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceExplorer2" }, "java": { "package": "software.amazon.awscdk.services.resourceexplorer2" }, "python": { "module": "aws_cdk.aws_resourceexplorer2" } } }, "aws-cdk-lib.aws_resourcegroups": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceGroups" }, "java": { "package": "software.amazon.awscdk.services.resourcegroups" }, "python": { "module": "aws_cdk.aws_resourcegroups" } } }, "aws-cdk-lib.aws_robomaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RoboMaker" }, "java": { "package": "software.amazon.awscdk.services.robomaker" }, "python": { "module": "aws_cdk.aws_robomaker" } } }, "aws-cdk-lib.aws_rolesanywhere": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RolesAnywhere" }, "java": { "package": "software.amazon.awscdk.services.rolesanywhere" }, "python": { "module": "aws_cdk.aws_rolesanywhere" } } }, "aws-cdk-lib.aws_route53": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53" }, "java": { "package": "software.amazon.awscdk.services.route53" }, "python": { "module": "aws_cdk.aws_route53" } } }, "aws-cdk-lib.aws_route53_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Patterns" }, "java": { "package": "software.amazon.awscdk.services.route53.patterns" }, "python": { "module": "aws_cdk.aws_route53_patterns" } } }, "aws-cdk-lib.aws_route53_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Targets" }, "java": { "package": "software.amazon.awscdk.services.route53.targets" }, "python": { "module": "aws_cdk.aws_route53_targets" } } }, "aws-cdk-lib.aws_route53recoverycontrol": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryControl" }, "java": { "package": "software.amazon.awscdk.services.route53recoverycontrol" }, "python": { "module": "aws_cdk.aws_route53recoverycontrol" } } }, "aws-cdk-lib.aws_route53recoveryreadiness": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryReadiness" }, "java": { "package": "software.amazon.awscdk.services.route53recoveryreadiness" }, "python": { "module": "aws_cdk.aws_route53recoveryreadiness" } } }, "aws-cdk-lib.aws_route53resolver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53Resolver" }, "java": { "package": "software.amazon.awscdk.services.route53resolver" }, "python": { "module": "aws_cdk.aws_route53resolver" } } }, "aws-cdk-lib.aws_rum": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RUM" }, "java": { "package": "software.amazon.awscdk.services.rum" }, "python": { "module": "aws_cdk.aws_rum" } } }, "aws-cdk-lib.aws_s3": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3" }, "java": { "package": "software.amazon.awscdk.services.s3" }, "python": { "module": "aws_cdk.aws_s3" } } }, "aws-cdk-lib.aws_s3_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Assets" }, "java": { "package": "software.amazon.awscdk.services.s3.assets" }, "python": { "module": "aws_cdk.aws_s3_assets" } } }, "aws-cdk-lib.aws_s3_deployment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Deployment" }, "java": { "package": "software.amazon.awscdk.services.s3.deployment" }, "python": { "module": "aws_cdk.aws_s3_deployment" } } }, "aws-cdk-lib.aws_s3_notifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Notifications" }, "java": { "package": "software.amazon.awscdk.services.s3.notifications" }, "python": { "module": "aws_cdk.aws_s3_notifications" } } }, "aws-cdk-lib.aws_s3objectlambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3ObjectLambda" }, "java": { "package": "software.amazon.awscdk.services.s3objectlambda" }, "python": { "module": "aws_cdk.aws_s3objectlambda" } } }, "aws-cdk-lib.aws_s3outposts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3Outposts" }, "java": { "package": "software.amazon.awscdk.services.s3outposts" }, "python": { "module": "aws_cdk.aws_s3outposts" } } }, "aws-cdk-lib.aws_sagemaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Sagemaker" }, "java": { "package": "software.amazon.awscdk.services.sagemaker" }, "python": { "module": "aws_cdk.aws_sagemaker" } } }, "aws-cdk-lib.aws_sam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SAM" }, "java": { "package": "software.amazon.awscdk.services.sam" }, "python": { "module": "aws_cdk.aws_sam" } } }, "aws-cdk-lib.aws_scheduler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Scheduler" }, "java": { "package": "software.amazon.awscdk.services.scheduler" }, "python": { "module": "aws_cdk.aws_scheduler" } } }, "aws-cdk-lib.aws_sdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SDB" }, "java": { "package": "software.amazon.awscdk.services.sdb" }, "python": { "module": "aws_cdk.aws_sdb" } } }, "aws-cdk-lib.aws_secretsmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecretsManager" }, "java": { "package": "software.amazon.awscdk.services.secretsmanager" }, "python": { "module": "aws_cdk.aws_secretsmanager" } } }, "aws-cdk-lib.aws_securityhub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecurityHub" }, "java": { "package": "software.amazon.awscdk.services.securityhub" }, "python": { "module": "aws_cdk.aws_securityhub" } } }, "aws-cdk-lib.aws_servicecatalog": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalog" }, "java": { "package": "software.amazon.awscdk.services.servicecatalog" }, "python": { "module": "aws_cdk.aws_servicecatalog" } } }, "aws-cdk-lib.aws_servicecatalogappregistry": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalogappregistry" }, "java": { "package": "software.amazon.awscdk.services.servicecatalogappregistry" }, "python": { "module": "aws_cdk.aws_servicecatalogappregistry" } } }, "aws-cdk-lib.aws_servicediscovery": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ServiceDiscovery" }, "java": { "package": "software.amazon.awscdk.services.servicediscovery" }, "python": { "module": "aws_cdk.aws_servicediscovery" } } }, "aws-cdk-lib.aws_ses": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES" }, "java": { "package": "software.amazon.awscdk.services.ses" }, "python": { "module": "aws_cdk.aws_ses" } } }, "aws-cdk-lib.aws_ses_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES.Actions" }, "java": { "package": "software.amazon.awscdk.services.ses.actions" }, "python": { "module": "aws_cdk.aws_ses_actions" } } }, "aws-cdk-lib.aws_shield": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Shield" }, "java": { "package": "services.shield" }, "python": { "module": "aws_cdk.aws_shield" } } }, "aws-cdk-lib.aws_signer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Signer" }, "java": { "package": "software.amazon.awscdk.services.signer" }, "python": { "module": "aws_cdk.aws_signer" } } }, "aws-cdk-lib.aws_simspaceweaver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SimSpaceWeaver" }, "java": { "package": "software.amazon.awscdk.services.simspaceweaver" }, "python": { "module": "aws_cdk.aws_simspaceweaver" } } }, "aws-cdk-lib.aws_sns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS" }, "java": { "package": "software.amazon.awscdk.services.sns" }, "python": { "module": "aws_cdk.aws_sns" } } }, "aws-cdk-lib.aws_sns_subscriptions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS.Subscriptions" }, "java": { "package": "software.amazon.awscdk.services.sns.subscriptions" }, "python": { "module": "aws_cdk.aws_sns_subscriptions" } } }, "aws-cdk-lib.aws_sqs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SQS" }, "java": { "package": "software.amazon.awscdk.services.sqs" }, "python": { "module": "aws_cdk.aws_sqs" } } }, "aws-cdk-lib.aws_ssm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSM" }, "java": { "package": "software.amazon.awscdk.services.ssm" }, "python": { "module": "aws_cdk.aws_ssm" } } }, "aws-cdk-lib.aws_ssmcontacts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMContacts" }, "java": { "package": "software.amazon.awscdk.services.ssmcontacts" }, "python": { "module": "aws_cdk.aws_ssmcontacts" } } }, "aws-cdk-lib.aws_ssmincidents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMIncidents" }, "java": { "package": "software.amazon.awscdk.services.ssmincidents" }, "python": { "module": "aws_cdk.aws_ssmincidents" } } }, "aws-cdk-lib.aws_sso": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSO" }, "java": { "package": "software.amazon.awscdk.services.sso" }, "python": { "module": "aws_cdk.aws_sso" } } }, "aws-cdk-lib.aws_stepfunctions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions" }, "python": { "module": "aws_cdk.aws_stepfunctions" } } }, "aws-cdk-lib.aws_stepfunctions_tasks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions.Tasks" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions.tasks" }, "python": { "module": "aws_cdk.aws_stepfunctions_tasks" } } }, "aws-cdk-lib.aws_supportapp": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SupportApp" }, "java": { "package": "software.amazon.awscdk.services.supportapp" }, "python": { "module": "aws_cdk.aws_supportapp" } } }, "aws-cdk-lib.aws_synthetics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Synthetics" }, "java": { "package": "software.amazon.awscdk.services.synthetics" }, "python": { "module": "aws_cdk.aws_synthetics" } } }, "aws-cdk-lib.aws_systemsmanagersap": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SystemsManagerSAP" }, "java": { "package": "software.amazon.awscdk.services.systemsmanagersap" }, "python": { "module": "aws_cdk.aws_systemsmanagersap" } } }, "aws-cdk-lib.aws_timestream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Timestream" }, "java": { "package": "software.amazon.awscdk.services.timestream" }, "python": { "module": "aws_cdk.aws_timestream" } } }, "aws-cdk-lib.aws_transfer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Transfer" }, "java": { "package": "software.amazon.awscdk.services.transfer" }, "python": { "module": "aws_cdk.aws_transfer" } } }, "aws-cdk-lib.aws_verifiedpermissions": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.VerifiedPermissions" }, "java": { "package": "services.verifiedpermissions" }, "python": { "module": "aws_cdk.aws_verifiedpermissions" } } }, "aws-cdk-lib.aws_voiceid": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VoiceID" }, "java": { "package": "software.amazon.awscdk.services.voiceid" }, "python": { "module": "aws_cdk.aws_voiceid" } } }, "aws-cdk-lib.aws_vpclattice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VpcLattice" }, "java": { "package": "software.amazon.awscdk.services.vpclattice" }, "python": { "module": "aws_cdk.aws_vpclattice" } } }, "aws-cdk-lib.aws_waf": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAF" }, "java": { "package": "software.amazon.awscdk.services.waf" }, "python": { "module": "aws_cdk.aws_waf" } } }, "aws-cdk-lib.aws_wafregional": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFRegional" }, "java": { "package": "software.amazon.awscdk.services.waf.regional" }, "python": { "module": "aws_cdk.aws_wafregional" } } }, "aws-cdk-lib.aws_wafv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFv2" }, "java": { "package": "software.amazon.awscdk.services.wafv2" }, "python": { "module": "aws_cdk.aws_wafv2" } } }, "aws-cdk-lib.aws_wisdom": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Wisdom" }, "java": { "package": "software.amazon.awscdk.services.wisdom" }, "python": { "module": "aws_cdk.aws_wisdom" } } }, "aws-cdk-lib.aws_workspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WorkSpaces" }, "java": { "package": "software.amazon.awscdk.services.workspaces" }, "python": { "module": "aws_cdk.aws_workspaces" } } }, "aws-cdk-lib.aws_workspacesweb": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesWeb" }, "java": { "package": "services.workspacesweb" }, "python": { "module": "aws_cdk.aws_workspacesweb" } } }, "aws-cdk-lib.aws_xray": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.XRay" }, "java": { "package": "software.amazon.awscdk.services.xray" }, "python": { "module": "aws_cdk.aws_xray" } } }, "aws-cdk-lib.cloud_assembly_schema": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "package": "software.amazon.awscdk.cloudassembly.schema" }, "python": { "module": "aws_cdk.cloud_assembly_schema" } } }, "aws-cdk-lib.cloudformation_include": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudFormation.Include" }, "java": { "package": "software.amazon.awscdk.cloudformation.include" }, "python": { "module": "aws_cdk.cloudformation_include" } } }, "aws-cdk-lib.custom_resources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CustomResources" }, "java": { "package": "software.amazon.awscdk.customresources" }, "python": { "module": "aws_cdk.custom_resources" } } }, "aws-cdk-lib.cx_api": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CXAPI" }, "java": { "package": "software.amazon.awscdk.cxapi" }, "python": { "module": "aws_cdk.cx_api" } } }, "aws-cdk-lib.lambda_layer_awscli": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.AwsCli" }, "java": { "package": "software.amazon.awscdk.lambdalayer.awscli" }, "python": { "module": "aws_cdk.lambda_layer_awscli" } } }, "aws-cdk-lib.lambda_layer_kubectl": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.Kubectl" }, "java": { "package": "software.amazon.awscdk.lambdalayer.kubectl" }, "python": { "module": "aws_cdk.lambda_layer_kubectl" } } }, "aws-cdk-lib.lambda_layer_node_proxy_agent": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.NodeProxyAgent" }, "java": { "package": "software.amazon.awscdk.lambda.layer.node.proxy.agent" }, "python": { "module": "aws_cdk.lambda_layer_node_proxy_agent" } } }, "aws-cdk-lib.pipelines": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Pipelines" }, "java": { "package": "software.amazon.awscdk.pipelines" }, "python": { "module": "aws_cdk.pipelines" } } }, "aws-cdk-lib.region_info": { "targets": { "dotnet": { "namespace": "Amazon.CDK.RegionInfo" }, "java": { "package": "software.amazon.awscdk.regioninfo" }, "python": { "module": "aws_cdk.region_info" } } }, "aws-cdk-lib.triggers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Triggers" }, "java": { "package": "software.amazon.awscdk.triggers" }, "python": { "module": "aws_cdk.triggers" } } } }, "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK.Lib" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdk" }, "java": { "maven": { "artifactId": "aws-cdk-lib", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "aws-cdk-lib" }, "python": { "distName": "aws-cdk-lib", "module": "aws_cdk" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "MongoDB Atlas CDK Construct Library for AWS CloudFormation Resources", "docs": { "stability": "stable" }, "homepage": "https://github.com/mongodb/awscdk-resources-mongodbatlas.git", "jsiiVersion": "5.6.5 (build 8ebf181)", "keywords": [ "atlas", "aws-cdk", "awscdk", "cdk", "cfn", "cfn-resources", "cloudformation", "cloudformation-registry", "constructs", "extensions", "l1", "l2", "l3", "mongodb" ], "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "awscdk-resources-mongodbatlas", "readme": { "markdown": "# MongoDB Atlas AWS CDK Resources\n[![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)\n[![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)\n[![npm version](https://badge.fury.io/js/awscdk-resources-mongodbatlas.svg)](https://badge.fury.io/js/awscdk-resources-mongodbatlas)\n[![PyPI version](https://badge.fury.io/py/awscdk-resources-mongodbatlas.svg)](https://badge.fury.io/py/awscdk-resources-mongodbatlas)\n[![NuGet version](https://badge.fury.io/nu/MongoDB.AWSCDKResourcesMongoDBAtlas.svg)](https://badge.fury.io/nu/MongoDB.AWSCDKResourcesMongoDBAtlas)\n[![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)\n[![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)\n\n[![View on Construct Hub](https://constructs.dev/badge?package=aws-cdk-lib)](https://constructs.dev/packages/awscdk-resources-mongodbatlas)\n\nUse 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.\n\n## Available Packages\n\n### NPM\nThe npm package is available at [awscdk-resources-mongodbatlas](https://www.npmjs.com/package/awscdk-resources-mongodbatlas)\n```bash\nnpm i awscdk-resources-mongodbatlas\n```\n\n### PyPI\nThe PyPI package is available at [awscdk-resources-mongodbatlas](https://pypi.org/project/awscdk-resources-mongodbatlas/)\n```bash\npip install awscdk-resources-mongodbatlas\n```\n\n### Nuget\nThe Nuget package is available at [MongoDB.AWSCDKResourcesMongoDBAtlas](https://www.nuget.org/packages/MongoDB.AWSCDKResourcesMongoDBAtlas)\n```bash\ndotnet add package MongoDB.AWSCDKResourcesMongoDBAtlas --version 1.0.0\n```\n\n### Maven\nThe Maven package is available at [awscdk-resources-mongodbatlas](https://central.sonatype.com/artifact/org.mongodb/awscdk-resources-mongodbatlas/1.0.0)\n\n```Maven\n\n org.mongodb\n awscdk-resources-mongodbatlas\n 1.0.0\n\n```\n\n### Go\nThe go package is generated into the [github.com/mongodb/awscdk-resources-mongodbatlas-go](https://github.com/mongodb/awscdk-resources-mongodbatlas-go) package.\n```bash\ngo get github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas\n```\n\n\n\n## Available Constructors\nMongoDB 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.\n## Getting Started\nSee 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/).\n\n## Support, Bugs, Feature Requests\nFeature requests can be submitted at [feedback.mongodb.com](https://feedback.mongodb.com/forums/924145-atlas/category/392596-atlas-cloudformation-resources) - just select \"Atlas CloudFormation Resources\" as the category or vote for an already suggested feature.\n\nSupport 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.\n\n## MongoDB Atlas API Keys Credential Management\nAtlas 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.\n\nAWS 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/).\n\n`NOTE: the process for configuring the PROFILE is the same and is required both for CloudFormation and CDK`\n\n### 1. Configure your MongoDB Atlas API Keys\nYou'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.\nRefer to the [Atlas documentation](https://www.mongodb.com/docs/atlas/configure-api-access/#manage-programmatic-access-to-an-organization) for detailed instructions.\n\n### 2. Configure your Profile\nTo use Atlas CloudFormation resources, you must configure a \"profile\" with your API keys using [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).\n\nThe secret should follow this format:\n```\nSecretName: cfn/atlas/profile/{ProfileName}\nSecretValue: {\"PublicKey\": \"YourPublicKey\", \"PrivateKey\": \"YourPrivateKey\"}\n```\n\nTo create a new secret for a default profile, use the [PROFILE SECRET TEMPLATE](/examples/profile-secret.yaml) file provided in this repository.\n\nHere are some examples of how to use this template:\n\n#### example 1:\n```\nProfileName: default\nSecretName: cfn/atlas/profile/default\nSecretValue: {\"PublicKey\": \"YourPublicKey\", \"PrivateKey\": \"YourPrivateKey\"}\n```\n#### example 2:\n```\nProfileName: testProfile\nSecretName: cfn/atlas/profile/testProfile\nSecretValue: {\"PublicKey\": \"YourPublicKey\", \"PrivateKey\": \"YourPrivateKey\"}\n```\n\n## Contributing\nSee our [CONTRIBUTING.md](CONTRIBUTING.md) guide.\n\n## Issues\n\n### Autoclose stale issues and PRs\n- 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!```\n- After 5 more days of no activity we automatically close the issue/PR.\n\n### One-click reproducible issues principle\nOur support will prioritise issues that contain all the required information that follows the following principles:\n\n* We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**.\n * This means that you should kindly **provide all the required instructions**. This includes but not limited to:\n * AWS CDK package version used to reproduce the issue\n * CFN resource version and AWS region used to reproduce the issue\n * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed.\n* 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:\n * If other CDK constructors are required, please make sure you also include those. _Same \"one-click reproducible issue\" principle applies_.\n * If external components are required to replicate it, please make sure you also provides instructions on those parts.\n\n" }, "repository": { "type": "git", "url": "https://github.com/mongodb/awscdk-resources-mongodbatlas.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "namespace": "MongoDB.AWSCDKResourcesMongoDBAtlas", "packageId": "MongoDB.AWSCDKResourcesMongoDBAtlas" }, "go": { "moduleName": "github.com/mongodb/awscdk-resources-mongodbatlas-go", "packageName": "awscdkresourcesmongodbatlas" }, "java": { "maven": { "artifactId": "awscdk-resources-mongodbatlas", "groupId": "org.mongodb" }, "package": "org.mongodb.awscdk.resources.mongodbatlas" }, "js": { "npm": "awscdk-resources-mongodbatlas" }, "python": { "distName": "awscdk_resources_mongodbatlas", "module": "awscdk_resources_mongodbatlas" } }, "types": { "awscdk-resources-mongodbatlas.AccessListDefinition": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "accessListDefinition" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AccessListDefinition", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 63 }, "name": "AccessListDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#AwsSecurityGroup" }, "remarks": "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.", "stability": "stable", "summary": "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 76 }, "name": "awsSecurityGroup", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#CIDRBlock" }, "remarks": "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", "stability": "stable", "summary": "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 83 }, "name": "cidrBlock", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#Comment" }, "stability": "stable", "summary": "Remark that explains the purpose or scope of this IP access list entry." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 90 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#DeleteAfterDate" }, "remarks": "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.", "stability": "stable", "summary": "Date and time after which MongoDB Cloud deletes the temporary access list entry." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 69 }, "name": "deleteAfterDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#IPAddress" }, "remarks": "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.", "stability": "stable", "summary": "IP address that you want to add to the project's IP access list." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 97 }, "name": "ipAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "accessListDefinition#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 104 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/project-ip-access-list/index:AccessListDefinition" }, "awscdk-resources-mongodbatlas.Action": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Action" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Action", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 75 }, "name": "Action", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Action#Action" }, "stability": "stable", "summary": "Human-readable label that identifies the privilege action." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 81 }, "name": "action", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Action#Resources" }, "stability": "stable", "summary": "List of resources on which you grant the action." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 88 }, "name": "resources", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Resource" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/custom-db-role/index:Action" }, "awscdk-resources-mongodbatlas.AdvancedAutoScaling": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "advancedAutoScaling" }, "stability": "stable", "summary": "AWS Automatic Cluster Scaling." }, "fqn": "awscdk-resources-mongodbatlas.AdvancedAutoScaling", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 686 }, "name": "AdvancedAutoScaling", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "advancedAutoScaling#Compute" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 695 }, "name": "compute", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Compute" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedAutoScaling#DiskGB" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 690 }, "name": "diskGb", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DiskGb" } } ], "symbolId": "src/l1-resources/cluster/index:AdvancedAutoScaling" }, "awscdk-resources-mongodbatlas.AdvancedRegionConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "advancedRegionConfig" }, "remarks": "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.\n\nExample:\n\nIf 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.\",", "stability": "stable", "summary": "Hardware specifications for nodes set for a given region." }, "fqn": "awscdk-resources-mongodbatlas.AdvancedRegionConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 605 }, "name": "AdvancedRegionConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#AnalyticsAutoScaling" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 609 }, "name": "analyticsAutoScaling", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AdvancedAutoScaling" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#AnalyticsSpecs" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 634 }, "name": "analyticsSpecs", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Specs" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#AutoScaling" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 614 }, "name": "autoScaling", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AdvancedAutoScaling" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#BackingProviderName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 624 }, "name": "backingProviderName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#ElectableSpecs" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 639 }, "name": "electableSpecs", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Specs" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#Priority" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 644 }, "name": "priority", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#ProviderName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 629 }, "name": "providerName", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AdvancedRegionConfigProviderName" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#ReadOnlySpecs" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 649 }, "name": "readOnlySpecs", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Specs" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedRegionConfig#RegionName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 619 }, "name": "regionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:AdvancedRegionConfig" }, "awscdk-resources-mongodbatlas.AdvancedRegionConfigProviderName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "AdvancedRegionConfigProviderName" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AdvancedRegionConfigProviderName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 723 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "TENANT." }, "name": "TENANT" } ], "name": "AdvancedRegionConfigProviderName", "symbolId": "src/l1-resources/cluster/index:AdvancedRegionConfigProviderName" }, "awscdk-resources-mongodbatlas.AdvancedReplicationSpec": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "advancedReplicationSpec" }, "remarks": "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.", "stability": "stable", "summary": "List of settings that configure your cluster regions." }, "fqn": "awscdk-resources-mongodbatlas.AdvancedReplicationSpec", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 493 }, "name": "AdvancedReplicationSpec", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "advancedReplicationSpec#AdvancedRegionConfigs" }, "remarks": "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.\n\nExample:\n\nIf 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.\",", "stability": "stable", "summary": "Hardware specifications for nodes set for a given region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 517 }, "name": "advancedRegionConfigs", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AdvancedRegionConfig" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "advancedReplicationSpec#ID" }, "remarks": "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.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 499 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedReplicationSpec#NumShards" }, "remarks": "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.", "stability": "stable", "summary": "Positive integer that specifies the number of shards to deploy in each specified zone." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 506 }, "name": "numShards", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "advancedReplicationSpec#ZoneName" }, "remarks": "Provide this value only if \"clusterType\" : \"GEOSHARDED\".", "stability": "stable", "summary": "Human-readable label that identifies the zone in a Global Cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 524 }, "name": "zoneName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:AdvancedReplicationSpec" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupCopySettingView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupCopySettingView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 200 }, "name": "ApiAtlasDiskBackupCopySettingView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView#CloudProvider" }, "stability": "stable", "summary": "A label that identifies the cloud provider that stores the snapshot copy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 206 }, "name": "cloudProvider", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView#Frequencies" }, "stability": "stable", "summary": "List that describes which types of snapshots to copy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 234 }, "name": "frequencies", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView#RegionName" }, "stability": "stable", "summary": "Target region to copy snapshots belonging to replicationSpecId to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 213 }, "name": "regionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView#ReplicationSpecId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 220 }, "name": "replicationSpecId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupCopySettingView#ShouldCopyOplogs" }, "stability": "stable", "summary": "Flag that indicates whether to copy the oplogs to the target region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 227 }, "name": "shouldCopyOplogs", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:ApiAtlasDiskBackupCopySettingView" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotMemberView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 187 }, "name": "ApiAtlasDiskBackupShardedClusterSnapshotMemberView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotMemberView#CloudProvider" }, "remarks": "The resource returns this parameter when `\"type\": \"replicaSet\".`", "stability": "stable", "summary": "Human-readable label that identifies the cloud provider that stores this snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 193 }, "name": "cloudProvider", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotMemberView#Id" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 200 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotMemberView#ReplicaSetName" }, "stability": "stable", "summary": "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 207 }, "name": "replicaSetName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotMemberView" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider" }, "remarks": "The resource returns this parameter when `\"type\": \"replicaSet\".`", "stability": "stable", "summary": "Human-readable label that identifies the cloud provider that stores this snapshot." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 389 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" } ], "name": "ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotMemberViewCloudProvider" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 236 }, "name": "ApiAtlasDiskBackupShardedClusterSnapshotView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#CreatedAt" }, "remarks": "This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "stability": "stable", "summary": "Date and time when MongoDB Cloud took the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 242 }, "name": "createdAt", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#Description" }, "remarks": "The resource returns this parameter when `\"status\": \"onDemand\"`.", "stability": "stable", "summary": "Human-readable phrase or sentence that explains the purpose of the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 249 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#ExpiresAt" }, "remarks": "This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "stability": "stable", "summary": "Date and time when MongoDB Cloud deletes the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 256 }, "name": "expiresAt", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#FrequencyType" }, "stability": "stable", "summary": "Human-readable label that identifies how often this snapshot triggers." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 263 }, "name": "frequencyType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#Id" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 270 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#MasterKeyUUID" }, "remarks": "The resource returns this value when `\"encryptionEnabled\" : true`.", "stability": "stable", "summary": "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 277 }, "name": "masterKeyUuid", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#Members" }, "remarks": "The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", "stability": "stable", "summary": "List that includes the snapshots and the cloud provider that stores the snapshots." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 284 }, "name": "members", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#MongodVersion" }, "stability": "stable", "summary": "Version of the MongoDB host that this snapshot backs up." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 291 }, "name": "mongodVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#PolicyItems" }, "stability": "stable", "summary": "List that contains unique identifiers for the policy items." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 298 }, "name": "policyItems", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#SnapshotIds" }, "remarks": "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.", "stability": "stable", "summary": "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 305 }, "name": "snapshotIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#SnapshotType" }, "stability": "stable", "summary": "Human-readable label that identifies when this snapshot triggers." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 312 }, "name": "snapshotType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#Status" }, "stability": "stable", "summary": "Human-readable label that indicates the stage of the backup process for this snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 319 }, "name": "status", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewStatus" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#StorageSizeBytes" }, "stability": "stable", "summary": "Number of bytes taken to store the backup snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 326 }, "name": "storageSizeBytes", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotView#Type" }, "stability": "stable", "summary": "Human-readable label that categorizes the cluster as a replica set or sharded cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 333 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewType" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotView" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType" }, "stability": "stable", "summary": "Human-readable label that identifies how often this snapshot triggers." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 403 }, "members": [ { "docs": { "stability": "stable", "summary": "hourly." }, "name": "HOURLY" }, { "docs": { "stability": "stable", "summary": "daily." }, "name": "DAILY" }, { "docs": { "stability": "stable", "summary": "weekly." }, "name": "WEEKLY" }, { "docs": { "stability": "stable", "summary": "monthly." }, "name": "MONTHLY" } ], "name": "ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotViewFrequencyType" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType" }, "stability": "stable", "summary": "Human-readable label that identifies when this snapshot triggers." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 419 }, "members": [ { "docs": { "stability": "stable", "summary": "onDemand." }, "name": "ON_DEMAND" }, { "docs": { "stability": "stable", "summary": "scheduled." }, "name": "SCHEDULED" } ], "name": "ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotViewSnapshotType" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewStatus": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotViewStatus" }, "stability": "stable", "summary": "Human-readable label that indicates the stage of the backup process for this snapshot." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewStatus", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 431 }, "members": [ { "docs": { "stability": "stable", "summary": "queued." }, "name": "QUEUED" }, { "docs": { "stability": "stable", "summary": "inProgress." }, "name": "IN_PROGRESS" }, { "docs": { "stability": "stable", "summary": "completed." }, "name": "COMPLETED" }, { "docs": { "stability": "stable", "summary": "failed." }, "name": "FAILED" } ], "name": "ApiAtlasDiskBackupShardedClusterSnapshotViewStatus", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotViewStatus" }, "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ApiAtlasDiskBackupShardedClusterSnapshotViewType" }, "stability": "stable", "summary": "Human-readable label that categorizes the cluster as a replica set or sharded cluster." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotViewType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 447 }, "members": [ { "docs": { "stability": "stable", "summary": "REPLICA_SET." }, "name": "REPLICA_SET" }, { "docs": { "stability": "stable", "summary": "SHARDED_CLUSTER." }, "name": "SHARDED_CLUSTER" } ], "name": "ApiAtlasDiskBackupShardedClusterSnapshotViewType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:ApiAtlasDiskBackupShardedClusterSnapshotViewType" }, "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersTokenizer": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer" }, "remarks": "Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", "stability": "stable", "summary": "Tokenizer that you want to use to create tokens." }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersTokenizer", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 308 }, "name": "ApiAtlasFtsAnalyzersTokenizer", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#Group" }, "remarks": "Use `0` to extract all character groups.", "stability": "stable", "summary": "Index of the character group within the matching expression to extract into tokens." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 335 }, "name": "group", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#MaxGram" }, "stability": "stable", "summary": "Characters to include in the longest token that Atlas Search creates." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 314 }, "name": "maxGram", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#MaxTokenLength" }, "remarks": "Tokens greater than this length are split at this length into multiple tokens.", "stability": "stable", "summary": "Maximum number of characters in a single token." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 349 }, "name": "maxTokenLength", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#MinGram" }, "stability": "stable", "summary": "Characters to include in the shortest token that Atlas Search creates." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 321 }, "name": "minGram", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#Pattern" }, "stability": "stable", "summary": "Regular expression to match against." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 342 }, "name": "pattern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersTokenizer#Type" }, "stability": "stable", "summary": "Human-readable label that identifies this tokenizer type." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 328 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/search-index/index:ApiAtlasFtsAnalyzersTokenizer" }, "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersViewManual": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersViewManual" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersViewManual", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 152 }, "name": "ApiAtlasFtsAnalyzersViewManual", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersViewManual#CharFilters" }, "stability": "stable", "summary": "Filters that examine text one character at a time and perform filtering operations." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 158 }, "name": "charFilters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersViewManual#Name" }, "remarks": "Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`", "stability": "stable", "summary": "Human-readable name that identifies the custom analyzer." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 168 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersViewManual#TokenFilters" }, "remarks": "- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", "stability": "stable", "summary": "Filter that performs operations such as:." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 179 }, "name": "tokenFilters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSAnalyzersViewManual#Tokenizer" }, "remarks": "Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", "stability": "stable", "summary": "Tokenizer that you want to use to create tokens." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 186 }, "name": "tokenizer", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersTokenizer" } } ], "symbolId": "src/l1-resources/search-index/index:ApiAtlasFtsAnalyzersViewManual" }, "awscdk-resources-mongodbatlas.ApiAtlasFtsMappingsViewManual": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasFTSMappingsViewManual" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsMappingsViewManual", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 216 }, "name": "ApiAtlasFtsMappingsViewManual", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSMappingsViewManual#Dynamic" }, "remarks": "Required for search indexes if **mappings.fields** is omitted.", "stability": "stable", "summary": "Flag that indicates whether the index uses dynamic or static mappings." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 222 }, "name": "dynamic", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSMappingsViewManual#Fields" }, "remarks": "Stringify json representation of field with types and properties. Required for search indexes if **mappings.dynamic** is omitted or set to **false**.", "stability": "stable", "summary": "One or more field specifications for the Atlas Search index." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 229 }, "name": "fields", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/search-index/index:ApiAtlasFtsMappingsViewManual" }, "awscdk-resources-mongodbatlas.ApiAtlasFtsSynonymMappingDefinitionView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasFTSSynonymMappingDefinitionView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsSynonymMappingDefinitionView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 257 }, "name": "ApiAtlasFtsSynonymMappingDefinitionView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSSynonymMappingDefinitionView#Analyzer" }, "stability": "stable", "summary": "Specific pre-defined method chosen to apply to the synonyms to be searched." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 263 }, "name": "analyzer", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSSynonymMappingDefinitionView#Name" }, "remarks": "Each **synonym.name** must be unique within the same index definition.", "stability": "stable", "summary": "Human-readable label that identifies the synonym definition." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 270 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasFTSSynonymMappingDefinitionView#Source" }, "stability": "stable", "summary": "Data set that stores the mapping one or more words map to one or more synonyms of those words." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 277 }, "name": "source", "type": { "fqn": "awscdk-resources-mongodbatlas.SynonymSource" } } ], "symbolId": "src/l1-resources/search-index/index:ApiAtlasFtsSynonymMappingDefinitionView" }, "awscdk-resources-mongodbatlas.ApiAtlasNdsUserToDnMappingView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasNDSUserToDNMappingView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasNdsUserToDnMappingView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 133 }, "name": "ApiAtlasNdsUserToDnMappingView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasNDSUserToDNMappingView#LdapQuery" }, "remarks": "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).", "stability": "stable", "summary": "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)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 139 }, "name": "ldapQuery", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasNDSUserToDNMappingView#Match" }, "remarks": "Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", "stability": "stable", "summary": "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 146 }, "name": "match", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasNDSUserToDNMappingView#Substitution" }, "stability": "stable", "summary": "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)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 153 }, "name": "substitution", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/ldap-configuration/index:ApiAtlasNdsUserToDnMappingView" }, "awscdk-resources-mongodbatlas.ApiAtlasPolicy": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasPolicy" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasPolicy", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 124 }, "name": "ApiAtlasPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasPolicy#Body" }, "remarks": "The syntax used is the Cedar Policy language.", "stability": "stable", "summary": "A string that defines the permissions for the policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 130 }, "name": "body", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasPolicy#Id" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 137 }, "name": "id", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/resource-policy/index:ApiAtlasPolicy" }, "awscdk-resources-mongodbatlas.ApiAtlasUserMetadata": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiAtlasUserMetadata" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiAtlasUserMetadata", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 83 }, "name": "ApiAtlasUserMetadata", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasUserMetadata#Id" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies a user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 89 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiAtlasUserMetadata#Name" }, "stability": "stable", "summary": "Human-readable label that describes a user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 96 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/resource-policy/index:ApiAtlasUserMetadata" }, "awscdk-resources-mongodbatlas.ApiDeleteCopiedBackupsView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiDeleteCopiedBackupsView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiDeleteCopiedBackupsView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 265 }, "name": "ApiDeleteCopiedBackupsView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiDeleteCopiedBackupsView#CloudProvider" }, "stability": "stable", "summary": "A label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 271 }, "name": "cloudProvider", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiDeleteCopiedBackupsView#RegionName" }, "stability": "stable", "summary": "Target region for the deleted copy setting whose backup copies you want to delete." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 278 }, "name": "regionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiDeleteCopiedBackupsView#ReplicationSpecId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 285 }, "name": "replicationSpecId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:ApiDeleteCopiedBackupsView" }, "awscdk-resources-mongodbatlas.ApiKey": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "APIKey" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiKey", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 130 }, "name": "ApiKey", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "APIKey#Description" }, "remarks": "1 to 250 characters", "stability": "stable", "summary": "Purpose or explanation provided when someone created this organization API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 136 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "APIKey#Roles" }, "remarks": "If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", "stability": "stable", "summary": "List of roles to grant this API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 143 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/organization/index:ApiKey" }, "awscdk-resources-mongodbatlas.ApiPolicyItemView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiPolicyItemView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiPolicyItemView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 394 }, "name": "ApiPolicyItemView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyItemView#FrequencyInterval" }, "stability": "stable", "summary": "Desired frequency of the new backup policy item specified by frequencyType." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 414 }, "name": "frequencyInterval", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyItemView#FrequencyType" }, "remarks": "One of the following values: hourly, daily, weekly, monthly or yearly.", "stability": "stable", "summary": "Frequency associated with the backup policy item." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 407 }, "name": "frequencyType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyItemView#ID" }, "stability": "stable", "summary": "Unique identifier of the backup policy item." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 400 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyItemView#RetentionUnit" }, "stability": "stable", "summary": "Metric of duration of the backup policy item: days, weeks, months or years." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 428 }, "name": "retentionUnit", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyItemView#RetentionValue" }, "remarks": "Associated with retentionUnit.", "stability": "stable", "summary": "Duration for which the backup is kept." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 421 }, "name": "retentionValue", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:ApiPolicyItemView" }, "awscdk-resources-mongodbatlas.ApiPolicyView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiPolicyView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiPolicyView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 314 }, "name": "ApiPolicyView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyView#ID" }, "remarks": "The policy id can be retrieved by running: atlas backups schedule describe \"${clusterName}\" --projectId \"${projectId}\" | jq -r '.policies[0].id'", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies this backup policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 320 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiPolicyView#PolicyItems" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 325 }, "name": "policyItems", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiPolicyItemView" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:ApiPolicyView" }, "awscdk-resources-mongodbatlas.ApiSearchDeploymentSpec": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ApiSearchDeploymentSpec" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ApiSearchDeploymentSpec", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 67 }, "name": "ApiSearchDeploymentSpec", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ApiSearchDeploymentSpec#InstanceSize" }, "remarks": "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).", "stability": "stable", "summary": "Hardware specification for the search node instance sizes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 73 }, "name": "instanceSize", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ApiSearchDeploymentSpec#NodeCount" }, "stability": "stable", "summary": "Number of search nodes in the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 80 }, "name": "nodeCount", "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/search-deployment/index:ApiSearchDeploymentSpec" }, "awscdk-resources-mongodbatlas.AtlasBasic": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "custom": { "class": "AtlasBasic", "description": "true", "export": "true", "extends": "Construct" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasBasic", "initializer": { "docs": { "custom": { "memberof": "AtlasBasic" }, "stability": "stable", "summary": "Creates an instance of AtlasBasic." }, "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 80 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasBasicProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 47 }, "name": "AtlasBasic", "properties": [ { "docs": { "custom": { "description": "true", "memberof": "AtlasBasic", "type": "{ipAccessList.CfnProjectIpAccessList}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 71 }, "name": "ipAccessList", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessList" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasBasic", "type": "{atlas.CfnCluster}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 59 }, "name": "mCluster", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCluster" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasBasic", "type": "{user.CfnDatabaseUser}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 65 }, "name": "mDBUser", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUser" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasBasic", "type": "{project.CfnProject}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic/index.ts", "line": 53 }, "name": "mProject", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProject" } } ], "symbolId": "src/l3-resources/atlas-basic/index:AtlasBasic" }, "awscdk-resources-mongodbatlas.AtlasBasicPrivateEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "custom": { "class": "AtlasBasicPrivateEndpoint", "description": "true", "export": "true", "extends": "Construct" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasBasicPrivateEndpoint", "initializer": { "docs": { "custom": { "memberof": "AtlasBasicPrivateEndpoint" }, "stability": "stable", "summary": "Creates an instance of AtlasBasicPrivateEndpoint." }, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 51 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasBasicPrivateEndpointProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 38 }, "name": "AtlasBasicPrivateEndpoint", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 39 }, "name": "atlasBasic", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasBasic" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 41 }, "name": "awsPrivateEndpoint", "type": { "fqn": "aws-cdk-lib.aws_ec2.CfnVPCEndpoint" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 42 }, "name": "privateEndpointAws", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAws" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 40 }, "name": "privateEndpointService", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointService" } } ], "symbolId": "src/l3-resources/atlas-basic-private-endpoint/index:AtlasBasicPrivateEndpoint" }, "awscdk-resources-mongodbatlas.AtlasBasicPrivateEndpointProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "AtlasBasicPrivateEndpointProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasBasicPrivateEndpointProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 114 }, "name": "AtlasBasicPrivateEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasPrivateEndpointProps", "type": "{AtlasBasicProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 129 }, "name": "atlasBasicProps", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasBasicProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasPrivateEndpointProps", "type": "{CfnPrivateEndpointProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 135 }, "name": "privateEndpointProps", "type": { "fqn": "awscdk-resources-mongodbatlas.PrivateEndpointProps" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 115 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "AWS Region", "memberof": "AtlasPrivateEndpointProps", "type": "{string}" }, "default": "us-east-1", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 123 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/atlas-basic-private-endpoint/index:AtlasBasicPrivateEndpointProps" }, "awscdk-resources-mongodbatlas.AtlasBasicProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "AtlasBasicProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasBasicProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 12 }, "name": "AtlasBasicProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasBasicProps", "type": "{ClusterProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 31 }, "name": "clusterProps", "type": { "fqn": "awscdk-resources-mongodbatlas.ClusterProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasBasicProps", "type": "{IpAccessListProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 43 }, "name": "ipAccessListProps", "type": { "fqn": "awscdk-resources-mongodbatlas.IpAccessListProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasBasicProps", "type": "{ProjectProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 25 }, "name": "projectProps", "type": { "fqn": "awscdk-resources-mongodbatlas.ProjectProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasBasicProps", "type": "{DatabaseUserProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 37 }, "name": "dbUserProps", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DatabaseUserProps" } }, { "abstract": true, "docs": { "custom": { "description": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used", "memberof": "AtlasBasicProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 18 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/common/props:AtlasBasicProps" }, "awscdk-resources-mongodbatlas.AtlasEncryptionAtRest": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "custom": { "class": "AtlasEncryptionAtRest", "export": "true", "extends": "Construct" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRest", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 96 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 87 }, "name": "AtlasEncryptionAtRest", "properties": [ { "docs": { "custom": { "memberof": "AtlasEncryptionAtRest", "type": "{CfnEncryptionAtRest}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 94 }, "name": "cfnEncryptionAtRest", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRest" } } ], "symbolId": "src/l2-resources/encryption-at-rest/index:AtlasEncryptionAtRest" }, "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestExpress": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestExpress", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 144 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestExpressProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 138 }, "name": "AtlasEncryptionAtRestExpress", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 139 }, "name": "encryptionAtRest", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRest" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 141 }, "name": "accessList", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessList" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 140 }, "name": "cluster", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCluster" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 142 }, "name": "databaseUser", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUser" } } ], "symbolId": "src/l3-resources/encryption-at-rest-express/index:AtlasEncryptionAtRestExpress" }, "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestExpressProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestExpressProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 129 }, "name": "AtlasEncryptionAtRestExpressProps", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 132 }, "name": "encryptionAtRest", "type": { "fqn": "awscdk-resources-mongodbatlas.EncryptionAtRestProps" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 135 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 131 }, "name": "accessList", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.IpAccessListProps" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 130 }, "name": "cluster", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ClusterProps" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 133 }, "name": "databaseUser", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DatabaseUserProps" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 134 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/encryption-at-rest-express/index:AtlasEncryptionAtRestExpressProps" }, "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasEncryptionAtRestProps", "kind": "interface", "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 20 }, "name": "AtlasEncryptionAtRestProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AwsKms#CustomerMasterKeyID" }, "stability": "stable", "summary": "The AWS customer master key used to encrypt and decrypt the MongoDB master keys." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 32 }, "name": "customerMasterKeyId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps#ProjectId" }, "stability": "stable", "summary": "Unique identifier of the Atlas project to which the user belongs." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 51 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#RoleID" }, "stability": "stable", "summary": "ID of an AWS IAM role authorized to manage an AWS customer master key." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 26 }, "name": "roleId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#Enabled" }, "remarks": "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.\nDefault Value: true", "stability": "stable", "summary": "Specifies whether Encryption at Rest is enabled for an Atlas project." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 38 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 59 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#Region" }, "remarks": "Default Value: US_EAST_1", "stability": "stable", "summary": "The AWS region in which the AWS customer master key exists." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/encryption-at-rest/index.ts", "line": 44 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l2-resources/encryption-at-rest/index:AtlasEncryptionAtRestProps" }, "awscdk-resources-mongodbatlas.AtlasRole": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "AtlasRole" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasRole", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 261 }, "name": "AtlasRole", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AtlasRole#OrgId" }, "remarks": "You can set a value for this parameter or **groupId** but not both in the same request", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 274 }, "name": "orgId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasRole#ProjectId" }, "remarks": "You can set a value for this parameter or **orgId** but not both in the same request.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the project to which this role belongs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 267 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasRole#RoleName" }, "remarks": "These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY", "stability": "stable", "summary": "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 300 }, "name": "roleName", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasRoleRoleName" } } ], "symbolId": "src/l1-resources/teams/index:AtlasRole" }, "awscdk-resources-mongodbatlas.AtlasRoleRoleName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "AtlasRoleRoleName" }, "remarks": "These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY", "stability": "stable", "summary": "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team." }, "fqn": "awscdk-resources-mongodbatlas.AtlasRoleRoleName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 350 }, "members": [ { "docs": { "stability": "stable", "summary": "ORG_OWNER." }, "name": "ORG_OWNER" }, { "docs": { "stability": "stable", "summary": "ORG_MEMBER." }, "name": "ORG_MEMBER" }, { "docs": { "stability": "stable", "summary": "ORG_GROUP_CREATOR." }, "name": "ORG_GROUP_CREATOR" }, { "docs": { "stability": "stable", "summary": "ORG_BILLING_ADMIN." }, "name": "ORG_BILLING_ADMIN" }, { "docs": { "stability": "stable", "summary": "ORG_READ_ONLY." }, "name": "ORG_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_CLUSTER_MANAGER." }, "name": "GROUP_CLUSTER_MANAGER" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_ADMIN." }, "name": "GROUP_DATA_ACCESS_ADMIN" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_ONLY." }, "name": "GROUP_DATA_ACCESS_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_WRITE." }, "name": "GROUP_DATA_ACCESS_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "GROUP_OWNER." }, "name": "GROUP_OWNER" }, { "docs": { "stability": "stable", "summary": "GROUP_READ_ONLY." }, "name": "GROUP_READ_ONLY" } ], "name": "AtlasRoleRoleName", "symbolId": "src/l1-resources/teams/index:AtlasRoleRoleName" }, "awscdk-resources-mongodbatlas.AtlasServerlessBasic": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "custom": { "class": "AtlasBasic", "description": "true", "export": "true", "extends": "Construct" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasServerlessBasic", "initializer": { "docs": { "custom": { "memberof": "AtlasServerlessBasic" }, "stability": "stable", "summary": "Creates an instance of AtlasServerlessBasic." }, "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 71 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.AtlasServerlessBasicProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 38 }, "name": "AtlasServerlessBasic", "properties": [ { "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasic", "type": "{ipAccessList.CfnProjectIpAccessList}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 62 }, "name": "ipAccessList", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessList" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasic", "type": "{user.CfnDatabaseUser}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 56 }, "name": "mDBUser", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUser" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasic", "type": "{project.CfnProject}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 44 }, "name": "mProject", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProject" } }, { "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasic", "type": "{atlas.CfnCluster}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-serverless-basic/index.ts", "line": 50 }, "name": "mserverless", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstance" } } ], "symbolId": "src/l3-resources/atlas-serverless-basic/index:AtlasServerlessBasic" }, "awscdk-resources-mongodbatlas.AtlasServerlessBasicProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasServerlessBasicProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 46 }, "name": "AtlasServerlessBasicProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasicProps", "type": "{ProjectProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 59 }, "name": "projectProps", "type": { "fqn": "awscdk-resources-mongodbatlas.ProjectProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasicProps", "type": "{serverlessProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 65 }, "name": "serverlessProps", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstanceProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasicProps", "type": "{DatabaseUserProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 71 }, "name": "dbUserProps", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DatabaseUserProps" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "AtlasServerlessBasicProps", "type": "{IpAccessListProps}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 77 }, "name": "ipAccessListProps", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.IpAccessListProps" } }, { "abstract": true, "docs": { "custom": { "description": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used", "memberof": "AtlasServerlessBasicProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 52 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/common/props:AtlasServerlessBasicProps" }, "awscdk-resources-mongodbatlas.AtlasUser": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "AtlasUser" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AtlasUser", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 109 }, "name": "AtlasUser", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Country" }, "remarks": "This parameter uses the ISO 3166-1a2 code format.", "stability": "stable", "summary": "Two alphabet characters that identifies MongoDB Cloud user's geographic location." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 115 }, "name": "country", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#EmailAddress" }, "stability": "stable", "summary": "Email address that belongs to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 122 }, "name": "emailAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#FirstName" }, "stability": "stable", "summary": "First or given name that belongs to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 129 }, "name": "firstName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Id" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 136 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#LastName" }, "stability": "stable", "summary": "Last name, family name, or surname that belongs to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 143 }, "name": "lastName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Links" }, "remarks": "RFC 5988 outlines these relationships.", "stability": "stable", "summary": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 150 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Link" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#MobileNumber" }, "stability": "stable", "summary": "Mobile phone number that belongs to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 157 }, "name": "mobileNumber", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Password" }, "remarks": "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.", "stability": "stable", "summary": "Password applied with the username to log in to MongoDB Cloud." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 164 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Roles" }, "remarks": "A role can apply to one organization or one project but not both.", "stability": "stable", "summary": "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 171 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AtlasRole" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#TeamIds" }, "stability": "stable", "summary": "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 178 }, "name": "teamIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "AtlasUser#Username" }, "stability": "stable", "summary": "Email address that represents the username of the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 185 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/teams/index:AtlasUser" }, "awscdk-resources-mongodbatlas.AuthConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "AuthConfig" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AuthConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 286 }, "name": "AuthConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AuthConfig#OperationType" }, "stability": "stable", "summary": "The type of authentication event that the trigger listens for." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 292 }, "name": "operationType", "type": { "fqn": "awscdk-resources-mongodbatlas.AuthConfigOperationType" } }, { "abstract": true, "docs": { "custom": { "schema": "AuthConfig#Providers" }, "stability": "stable", "summary": "The type(s) of authentication provider that the trigger listens to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 299 }, "name": "providers", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AuthConfigProviders" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/trigger/index:AuthConfig" }, "awscdk-resources-mongodbatlas.AuthConfigOperationType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "AuthConfigOperationType" }, "stability": "stable", "summary": "The type of authentication event that the trigger listens for." }, "fqn": "awscdk-resources-mongodbatlas.AuthConfigOperationType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 423 }, "members": [ { "docs": { "stability": "stable", "summary": "LOGIN." }, "name": "LOGIN" }, { "docs": { "stability": "stable", "summary": "CREATE." }, "name": "CREATE" }, { "docs": { "stability": "stable", "summary": "DELETE." }, "name": "DELETE" } ], "name": "AuthConfigOperationType", "symbolId": "src/l1-resources/trigger/index:AuthConfigOperationType" }, "awscdk-resources-mongodbatlas.AuthConfigProviders": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "AuthConfigProviders" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.AuthConfigProviders", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 435 }, "members": [ { "docs": { "stability": "stable", "summary": "anon-user." }, "name": "ANON_USER" }, { "docs": { "stability": "stable", "summary": "api-key." }, "name": "API_KEY" }, { "docs": { "stability": "stable", "summary": "custom-token." }, "name": "CUSTOM_TOKEN" }, { "docs": { "stability": "stable", "summary": "custom-function." }, "name": "CUSTOM_FUNCTION" }, { "docs": { "stability": "stable", "summary": "local-userpass." }, "name": "LOCAL_USERPASS" }, { "docs": { "stability": "stable", "summary": "oauth2-apple." }, "name": "OAUTH2_APPLE" }, { "docs": { "stability": "stable", "summary": "oauth2-facebook." }, "name": "OAUTH2_FACEBOOK" }, { "docs": { "stability": "stable", "summary": "oauth2-google." }, "name": "OAUTH2_GOOGLE" } ], "name": "AuthConfigProviders", "symbolId": "src/l1-resources/trigger/index:AuthConfigProviders" }, "awscdk-resources-mongodbatlas.AwsKmsConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "AwsKmsConfig" }, "stability": "stable", "summary": "Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project." }, "fqn": "awscdk-resources-mongodbatlas.AwsKmsConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 59 }, "name": "AwsKmsConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AwsKmsConfig#CustomerMasterKeyID" }, "stability": "stable", "summary": "The AWS customer master key used to encrypt and decrypt the MongoDB master keys." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 72 }, "name": "customerMasterKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKmsConfig#Enabled" }, "remarks": "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.", "stability": "stable", "summary": "Specifies whether Encryption at Rest is enabled for an Atlas project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 79 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKmsConfig#Region" }, "stability": "stable", "summary": "The AWS region in which the AWS customer master key exists." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 86 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKmsConfig#RoleID" }, "stability": "stable", "summary": "ID of an AWS IAM role authorized to manage an AWS customer master key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 65 }, "name": "roleId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/encryption-at-rest/index:AwsKmsConfig" }, "awscdk-resources-mongodbatlas.AwsPrivateEndpointConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig" }, "stability": "stable", "summary": "AWS Private endpoint configuration properties." }, "fqn": "awscdk-resources-mongodbatlas.AwsPrivateEndpointConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 103 }, "name": "AwsPrivateEndpointConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig#AWSPrivateEndpointStatus" }, "stability": "stable", "summary": "Status of the AWS PrivateEndpoint connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 130 }, "name": "awsPrivateEndpointStatus", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig#InterfaceEndpointId" }, "stability": "stable", "summary": "Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 123 }, "name": "interfaceEndpointId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig#Region" }, "stability": "stable", "summary": "Aws Region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 137 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig#SubnetIds" }, "stability": "stable", "summary": "List of string representing the AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 116 }, "name": "subnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "awsPrivateEndpointConfig#VpcId" }, "stability": "stable", "summary": "String Representing the AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 109 }, "name": "vpcId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/serverless-private-endpoint/index:AwsPrivateEndpointConfig" }, "awscdk-resources-mongodbatlas.CfnAccessListApiKey": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::AccessListAPIKey" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::AccessListAPIKey`." }, "fqn": "awscdk-resources-mongodbatlas.CfnAccessListApiKey", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::AccessListAPIKey`." }, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 110 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAccessListApiKeyProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 86 }, "name": "CfnAccessListApiKey", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 90 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::AccessListAPIKey.Entry`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 101 }, "name": "attrEntry", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 96 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAccessListApiKeyProps" } } ], "symbolId": "src/l1-resources/access-list-api-key/index:CfnAccessListApiKey" }, "awscdk-resources-mongodbatlas.CfnAccessListApiKeyProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps" }, "stability": "stable", "summary": "Creates the access list entries for the specified organization API key." }, "fqn": "awscdk-resources-mongodbatlas.CfnAccessListApiKeyProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 10 }, "name": "CfnAccessListApiKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#APIUserId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 23 }, "name": "apiUserId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#OrgId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 16 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#CidrBlock" }, "stability": "stable", "summary": "Range of network addresses that you want to add to the access list for the API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 37 }, "name": "cidrBlock", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#IpAddress" }, "stability": "stable", "summary": "Network address that you want to add to the access list for the API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 44 }, "name": "ipAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#Profile" }, "stability": "stable", "summary": "Network address that issued the most recent request to the API." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 30 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAccessListApiKeyProps#TotalCount" }, "stability": "stable", "summary": "Number of documents returned in this response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/access-list-api-key/index.ts", "line": 51 }, "name": "totalCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/access-list-api-key/index:CfnAccessListApiKeyProps" }, "awscdk-resources-mongodbatlas.CfnAlertConfiguration": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::AlertConfiguration" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::AlertConfiguration`." }, "fqn": "awscdk-resources-mongodbatlas.CfnAlertConfiguration", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::AlertConfiguration`." }, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 747 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAlertConfigurationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 711 }, "name": "CfnAlertConfiguration", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 715 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::AlertConfiguration.Created`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 738 }, "name": "attrCreated", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::AlertConfiguration.Enabled`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 730 }, "name": "attrEnabled", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::AlertConfiguration.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 726 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::AlertConfiguration.Updated`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 734 }, "name": "attrUpdated", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 721 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAlertConfigurationProps" } } ], "symbolId": "src/l1-resources/alert-configuration/index:CfnAlertConfiguration" }, "awscdk-resources-mongodbatlas.CfnAlertConfigurationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps" }, "remarks": "This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.", "stability": "stable", "summary": "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users." }, "fqn": "awscdk-resources-mongodbatlas.CfnAlertConfigurationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 10 }, "name": "CfnAlertConfigurationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#EventTypeName" }, "stability": "stable", "summary": "Event type that triggers an alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 23 }, "name": "eventTypeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#Matchers" }, "remarks": "You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", "stability": "stable", "summary": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 37 }, "name": "matchers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Matcher" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#MetricThreshold" }, "remarks": "The resource returns this parameter when '\"eventTypeName\" : \"OUTSIDE_METRIC_THRESHOLD\"'.", "stability": "stable", "summary": "Threshold for the metric that, when exceeded, triggers an alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 44 }, "name": "metricThreshold", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MetricThresholdView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#Notifications" }, "stability": "stable", "summary": "List that contains the targets that MongoDB Cloud sends notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 51 }, "name": "notifications", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.NotificationView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 30 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#Threshold" }, "remarks": "The resource returns this parameter when **eventTypeName** has not been set to 'OUTSIDE_METRIC_THRESHOLD'.", "stability": "stable", "summary": "Limit that triggers an alert when exceeded." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 58 }, "name": "threshold", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.IntegerThresholdView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAlertConfigurationProps#TypeName" }, "stability": "stable", "summary": "Human-readable label that displays the alert type." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 65 }, "name": "typeName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/alert-configuration/index:CfnAlertConfigurationProps" }, "awscdk-resources-mongodbatlas.CfnApiKey": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::APIKey" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::APIKey`." }, "fqn": "awscdk-resources-mongodbatlas.CfnApiKey", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::APIKey`." }, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 221 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnApiKeyProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 190 }, "name": "CfnApiKey", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 194 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::APIKey.APIUserId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 212 }, "name": "attrAPIUserId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::APIKey.PrivateKey`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 204 }, "name": "attrPrivateKey", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::APIKey.PublicKey`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 208 }, "name": "attrPublicKey", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 199 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnApiKeyProps" } } ], "symbolId": "src/l1-resources/api-key/index:CfnApiKey" }, "awscdk-resources-mongodbatlas.CfnApiKeyProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnApiKeyProps" }, "remarks": "An organization API key grants programmatic access to an organization.", "stability": "stable", "summary": "Creates one API key for the specified organization." }, "fqn": "awscdk-resources-mongodbatlas.CfnApiKeyProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 10 }, "name": "CfnApiKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#AwsSecretName" }, "stability": "stable", "summary": "Name of the AWS Secrets Manager secret that stores the API key Details." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 23 }, "name": "awsSecretName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#Description" }, "stability": "stable", "summary": "Purpose or explanation provided when someone created this organization API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 16 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#OrgId" }, "remarks": "Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 30 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#AwsSecretArn" }, "stability": "stable", "summary": "ARN of the AWS Secrets Manager secret that stores the API key Details." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 44 }, "name": "awsSecretArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#ListOptions" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 61 }, "name": "listOptions", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ListOptions" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 37 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#ProjectAssignments" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 56 }, "name": "projectAssignments", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ProjectAssignment" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnApiKeyProps#Roles" }, "remarks": "If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", "stability": "stable", "summary": "List of roles to grant this API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 51 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/api-key/index:CfnApiKeyProps" }, "awscdk-resources-mongodbatlas.CfnAuditing": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Auditing" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Auditing`." }, "fqn": "awscdk-resources-mongodbatlas.CfnAuditing", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Auditing`." }, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 85 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAuditingProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 54 }, "name": "CfnAuditing", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 58 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Auditing.AuditAuthorizationSuccess`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 76 }, "name": "attrAuditAuthorizationSuccess", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Auditing.AuditFilter`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 68 }, "name": "attrAuditFilter", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Auditing.ConfigurationType`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 72 }, "name": "attrConfigurationType", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 63 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnAuditingProps" } } ], "symbolId": "src/l1-resources/auditing/index:CfnAuditing" }, "awscdk-resources-mongodbatlas.CfnAuditingProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnAuditingProps" }, "stability": "stable", "summary": "Returns and edits database auditing settings for MongoDB Cloud projects." }, "fqn": "awscdk-resources-mongodbatlas.CfnAuditingProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 10 }, "name": "CfnAuditingProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnAuditingProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnAuditingProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/auditing/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/auditing/index:CfnAuditingProps" }, "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobs": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CloudBackUpRestoreJobs" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CloudBackUpRestoreJobs`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobs", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CloudBackUpRestoreJobs`." }, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 318 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 266 }, "name": "CfnCloudBackUpRestoreJobs", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 270 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Cancelled`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 289 }, "name": "attrCancelled", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.DeliveryUrl`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 285 }, "name": "attrDeliveryUrl", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Expired`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 297 }, "name": "attrExpired", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.ExpiresAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 301 }, "name": "attrExpiresAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Failed`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 293 }, "name": "attrFailed", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.FinishedAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 305 }, "name": "attrFinishedAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 281 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackUpRestoreJobs.Timestamp`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 309 }, "name": "attrTimestamp", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 276 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsProps" } } ], "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:CfnCloudBackUpRestoreJobs" }, "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps" }, "stability": "stable", "summary": "Returns, starts, and cancels Cloud Backup restore jobs." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 10 }, "name": "CfnCloudBackUpRestoreJobsProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#DeliveryType" }, "stability": "stable", "summary": "Type of restore job to create.The value can be any one of download,automated or point_in_time." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 37 }, "name": "deliveryType", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsDeliveryType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#InstanceName" }, "stability": "stable", "summary": "The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore jobs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 30 }, "name": "instanceName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#InstanceType" }, "remarks": "**WARNING:** `serverless` instance type is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).", "stability": "stable", "summary": "Type of instance specified on the Instance Name serverless or cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 23 }, "name": "instanceType", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsInstanceType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#ProjectId" }, "stability": "stable", "summary": "The unique identifier of the project for the Atlas cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#SnapshotId" }, "stability": "stable", "summary": "Unique identifier of the source snapshot ID of the restore job." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 44 }, "name": "snapshotId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#EnableSynchronousCreation" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 100 }, "name": "enableSynchronousCreation", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#Links" }, "stability": "stable", "summary": "One or more links to sub-resources and/or related resources." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 51 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsLinks" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#OpLogInc" }, "remarks": "This is the second part of an Oplog timestamp.", "stability": "stable", "summary": "Oplog operation number from which to you want to restore this snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 65 }, "name": "opLogInc", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#OpLogTs" }, "remarks": "This is the first part of an Oplog timestamp.", "stability": "stable", "summary": "Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 58 }, "name": "opLogTs", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#PointInTimeUtcSeconds" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 72 }, "name": "pointInTimeUtcSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 93 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#SynchronousCreationOptions" }, "stability": "stable", "summary": "Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 107 }, "name": "synchronousCreationOptions", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.SynchronousCreationOptions" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#TargetClusterName" }, "remarks": "Only visible if deliveryType is automated.", "stability": "stable", "summary": "Name of the target Atlas cluster to which the restore job restores the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 86 }, "name": "targetClusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsProps#TargetProjectId" }, "remarks": "Only visible if deliveryType is automated.", "stability": "stable", "summary": "Name of the target Atlas project of the restore job." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 79 }, "name": "targetProjectId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:CfnCloudBackUpRestoreJobsProps" }, "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsDeliveryType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsPropsDeliveryType" }, "stability": "stable", "summary": "Type of restore job to create.The value can be any one of download,automated or point_in_time." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsDeliveryType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 163 }, "members": [ { "docs": { "stability": "stable", "summary": "download." }, "name": "DOWNLOAD" }, { "docs": { "stability": "stable", "summary": "automated." }, "name": "AUTOMATED" }, { "docs": { "stability": "stable", "summary": "pointInTime." }, "name": "POINT_IN_TIME" } ], "name": "CfnCloudBackUpRestoreJobsPropsDeliveryType", "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:CfnCloudBackUpRestoreJobsPropsDeliveryType" }, "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsInstanceType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsPropsInstanceType" }, "remarks": "**WARNING:** `serverless` instance type is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).", "stability": "stable", "summary": "Type of instance specified on the Instance Name serverless or cluster." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsInstanceType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 151 }, "members": [ { "docs": { "stability": "stable", "summary": "serverless." }, "name": "SERVERLESS" }, { "docs": { "stability": "stable", "summary": "cluster." }, "name": "CLUSTER" } ], "name": "CfnCloudBackUpRestoreJobsPropsInstanceType", "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:CfnCloudBackUpRestoreJobsPropsInstanceType" }, "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsLinks": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsPropsLinks" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackUpRestoreJobsPropsLinks", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 175 }, "name": "CfnCloudBackUpRestoreJobsPropsLinks", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsPropsLinks#Href" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 184 }, "name": "href", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackUpRestoreJobsPropsLinks#Rel" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 179 }, "name": "rel", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:CfnCloudBackUpRestoreJobsPropsLinks" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSchedule": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CloudBackupSchedule" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CloudBackupSchedule`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSchedule", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CloudBackupSchedule`." }, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 490 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupScheduleProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 462 }, "name": "CfnCloudBackupSchedule", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 466 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSchedule.ClusterId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 477 }, "name": "attrClusterId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSchedule.NextSnapshot`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 481 }, "name": "attrNextSnapshot", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 472 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupScheduleProps" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:CfnCloudBackupSchedule" }, "awscdk-resources-mongodbatlas.CfnCloudBackupScheduleProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps" }, "stability": "stable", "summary": "An example resource schema demonstrating some basic constructs and validation rules." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupScheduleProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 10 }, "name": "CfnCloudBackupScheduleProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#AutoExportEnabled" }, "stability": "stable", "summary": "Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 37 }, "name": "autoExportEnabled", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#ClusterName" }, "stability": "stable", "summary": "The name of the Atlas cluster that contains the snapshots you want to retrieve." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 23 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#CopySettings" }, "stability": "stable", "summary": "List that contains a document for each copy setting item in the desired backup policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 58 }, "name": "copySettings", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupCopySettingView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#DeleteCopiedBackups" }, "stability": "stable", "summary": "List that contains a document for each deleted copy setting whose backup copies you want to delete." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 65 }, "name": "deleteCopiedBackups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiDeleteCopiedBackupsView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#Export" }, "stability": "stable", "summary": "Policy for automatically exporting cloud backup snapshots." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 51 }, "name": "export", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Export" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#Id" }, "stability": "stable", "summary": "Unique identifier of the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 30 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#Links" }, "remarks": "RFC 5988 outlines these relationships.", "stability": "stable", "summary": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 114 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Link" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#Policies" }, "stability": "stable", "summary": "Rules set for this backup schedule." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 72 }, "name": "policies", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiPolicyView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 107 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#ProjectId" }, "stability": "stable", "summary": "The unique identifier of the project for the Atlas cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 16 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#ReferenceHourOfDay" }, "stability": "stable", "summary": "UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 79 }, "name": "referenceHourOfDay", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#ReferenceMinuteOfHour" }, "stability": "stable", "summary": "UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 86 }, "name": "referenceMinuteOfHour", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#RestoreWindowDays" }, "remarks": "Must be a positive, non-zero integer.", "stability": "stable", "summary": "Number of days back in time you can restore to with Continuous Cloud Backup accuracy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 93 }, "name": "restoreWindowDays", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#UpdateSnapshots" }, "stability": "stable", "summary": "Flag indicating if updates to retention in the backup policy were applied to snapshots that Atlas took earlier." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 100 }, "name": "updateSnapshots", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupScheduleProps#UseOrgAndGroupNamesInExportPrefix" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 44 }, "name": "useOrgAndGroupNamesInExportPrefix", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:CfnCloudBackupScheduleProps" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshot": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CloudBackupSnapshot" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CloudBackupSnapshot`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshot", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CloudBackupSnapshot`." }, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 528 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 460 }, "name": "CfnCloudBackupSnapshot", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 464 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.CloudProvider`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 507 }, "name": "attrCloudProvider", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.CreatedAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 503 }, "name": "attrCreatedAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.ExpiresAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 491 }, "name": "attrExpiresAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 499 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.MasterKeyUUID`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 483 }, "name": "attrMasterKeyUUID", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.MongodVersion`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 511 }, "name": "attrMongodVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.ReplicaSetName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 515 }, "name": "attrReplicaSetName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 475 }, "name": "attrSnapshotId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.SnapshotIds`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 479 }, "name": "attrSnapshotIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.Status`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 519 }, "name": "attrStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.StorageSizeBytes`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 495 }, "name": "attrStorageSizeBytes", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshot.Type`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 487 }, "name": "attrType", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 470 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotProps" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot/index:CfnCloudBackupSnapshot" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucket": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CloudBackupSnapshotExportBucket" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CloudBackupSnapshotExportBucket`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucket", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CloudBackupSnapshotExportBucket`." }, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 94 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucketProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 70 }, "name": "CfnCloudBackupSnapshotExportBucket", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 74 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::CloudBackupSnapshotExportBucket.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 85 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 80 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucketProps" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot-export-bucket/index:CfnCloudBackupSnapshotExportBucket" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucketProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotExportBucketProps" }, "stability": "stable", "summary": "The exportBuckets resource allows you to grant Atlas access to the specified bucket for exporting backup snapshots." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotExportBucketProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 10 }, "name": "CfnCloudBackupSnapshotExportBucketProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotExportBucketProps#BucketName" }, "stability": "stable", "summary": "Human-readable label that identifies the AWS bucket that the role is authorized to access." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 23 }, "name": "bucketName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotExportBucketProps#IamRoleID" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 37 }, "name": "iamRoleId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotExportBucketProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 30 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotExportBucketProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot-export-bucket/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot-export-bucket/index:CfnCloudBackupSnapshotExportBucketProps" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps" }, "stability": "stable", "summary": "Returns, takes, and removes Cloud Backup snapshots." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 10 }, "name": "CfnCloudBackupSnapshotProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#InstanceName" }, "stability": "stable", "summary": "The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 30 }, "name": "instanceName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#InstanceType" }, "stability": "stable", "summary": "Type of instance specified on the Instance Name serverless or cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 23 }, "name": "instanceType", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsInstanceType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 51 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#Description" }, "remarks": "The resource returns this parameter when `\"status\": \"onDemand\"`.", "stability": "stable", "summary": "Human-readable phrase or sentence that explains the purpose of the snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 37 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#FrequencyType" }, "stability": "stable", "summary": "Human-readable label that identifies how often this snapshot triggers." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 44 }, "name": "frequencyType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsFrequencyType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#IncludeCount" }, "stability": "stable", "summary": "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 58 }, "name": "includeCount", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#ItemsPerPage" }, "stability": "stable", "summary": "Number of items that the response returns per page." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 65 }, "name": "itemsPerPage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#Members" }, "remarks": "The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", "stability": "stable", "summary": "List that includes the snapshots and the cloud provider that stores the snapshots." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 72 }, "name": "members", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotMemberView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 79 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#PolicyItems" }, "stability": "stable", "summary": "List that contains unique identifiers for the policy items." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 86 }, "name": "policyItems", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#Results" }, "stability": "stable", "summary": "List of returned documents that MongoDB Cloud provides when completing this request." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 93 }, "name": "results", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasDiskBackupShardedClusterSnapshotView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#RetentionInDays" }, "remarks": "Must be at least **1**", "stability": "stable", "summary": "Number of days that MongoDB Cloud should retain the on-demand snapshot." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 100 }, "name": "retentionInDays", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#SnapshotType" }, "stability": "stable", "summary": "Human-readable label that identifies when this snapshot triggers." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 107 }, "name": "snapshotType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsSnapshotType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCloudBackupSnapshotProps#TotalCount" }, "stability": "stable", "summary": "Number of documents returned in this response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 114 }, "name": "totalCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/cloud-backup-snapshot/index:CfnCloudBackupSnapshotProps" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsFrequencyType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnCloudBackupSnapshotPropsFrequencyType" }, "stability": "stable", "summary": "Human-readable label that identifies how often this snapshot triggers." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsFrequencyType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 173 }, "members": [ { "docs": { "stability": "stable", "summary": "hourly." }, "name": "HOURLY" }, { "docs": { "stability": "stable", "summary": "daily." }, "name": "DAILY" }, { "docs": { "stability": "stable", "summary": "weekly." }, "name": "WEEKLY" }, { "docs": { "stability": "stable", "summary": "monthly." }, "name": "MONTHLY" } ], "name": "CfnCloudBackupSnapshotPropsFrequencyType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:CfnCloudBackupSnapshotPropsFrequencyType" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsInstanceType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnCloudBackupSnapshotPropsInstanceType" }, "stability": "stable", "summary": "Type of instance specified on the Instance Name serverless or cluster." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsInstanceType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 161 }, "members": [ { "docs": { "stability": "stable", "summary": "serverless." }, "name": "SERVERLESS" }, { "docs": { "stability": "stable", "summary": "cluster." }, "name": "CLUSTER" } ], "name": "CfnCloudBackupSnapshotPropsInstanceType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:CfnCloudBackupSnapshotPropsInstanceType" }, "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsSnapshotType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnCloudBackupSnapshotPropsSnapshotType" }, "stability": "stable", "summary": "Human-readable label that identifies when this snapshot triggers." }, "fqn": "awscdk-resources-mongodbatlas.CfnCloudBackupSnapshotPropsSnapshotType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cloud-backup-snapshot/index.ts", "line": 377 }, "members": [ { "docs": { "stability": "stable", "summary": "onDemand." }, "name": "ON_DEMAND" }, { "docs": { "stability": "stable", "summary": "scheduled." }, "name": "SCHEDULED" } ], "name": "CfnCloudBackupSnapshotPropsSnapshotType", "symbolId": "src/l1-resources/cloud-backup-snapshot/index:CfnCloudBackupSnapshotPropsSnapshotType" }, "awscdk-resources-mongodbatlas.CfnCluster": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Cluster" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Cluster`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCluster", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Cluster`." }, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 940 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 905 }, "name": "CfnCluster", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 909 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Cluster.CreatedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 927 }, "name": "attrCreatedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Cluster.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 931 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Cluster.MongoDBVersion`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 923 }, "name": "attrMongoDBVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Cluster.StateName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 919 }, "name": "attrStateName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 914 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterProps" } } ], "symbolId": "src/l1-resources/cluster/index:CfnCluster" }, "awscdk-resources-mongodbatlas.CfnClusterOutageSimulation": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ClusterOutageSimulation" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ClusterOutageSimulation`." }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterOutageSimulation", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ClusterOutageSimulation`." }, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 157 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterOutageSimulationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 125 }, "name": "CfnClusterOutageSimulation", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 129 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ClusterOutageSimulation.SimulationId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 140 }, "name": "attrSimulationId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ClusterOutageSimulation.StartRequestDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 144 }, "name": "attrStartRequestDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ClusterOutageSimulation.State`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 148 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 135 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterOutageSimulationProps" } } ], "symbolId": "src/l1-resources/cluster-outage-simulation/index:CfnClusterOutageSimulation" }, "awscdk-resources-mongodbatlas.CfnClusterOutageSimulationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnClusterOutageSimulationProps" }, "stability": "stable", "summary": "An example resource schema demonstrating some basic constructs and validation rules." }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterOutageSimulationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 10 }, "name": "CfnClusterOutageSimulationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnClusterOutageSimulationProps#ClusterName" }, "stability": "stable", "summary": "Human-readable label that identifies the cluster ." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 37 }, "name": "clusterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterOutageSimulationProps#OutageFilters" }, "remarks": "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.", "stability": "stable", "summary": "List of settings that configure your cluster regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 23 }, "name": "outageFilters", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Filter" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterOutageSimulationProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 16 }, "name": "profile", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterOutageSimulationProps#ProjectId" }, "stability": "stable", "summary": "Human-readable label that identifies the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 30 }, "name": "projectId", "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster-outage-simulation/index:CfnClusterOutageSimulationProps" }, "awscdk-resources-mongodbatlas.CfnClusterProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnClusterProps" }, "remarks": "The resource lets you create, edit and delete clusters. The resource requires your Project ID.", "stability": "stable", "summary": "The cluster resource provides access to your cluster configurations." }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 10 }, "name": "CfnClusterProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the advanced cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 98 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#ProjectId" }, "stability": "stable", "summary": "Unique identifier of the project the cluster belongs to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 77 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#AdvancedSettings" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 14 }, "name": "advancedSettings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ProcessArgs" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#BackupEnabled" }, "remarks": "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.", "stability": "stable", "summary": "Flag that indicates whether the cluster can perform backups." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 21 }, "name": "backupEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#BiConnector" }, "stability": "stable", "summary": "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 28 }, "name": "biConnector", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsBiConnector" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#ClusterType" }, "stability": "stable", "summary": "Configuration of nodes that comprise the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 35 }, "name": "clusterType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#ConnectionStrings" }, "remarks": "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.", "stability": "stable", "summary": "Set of connection strings that your applications use to connect to this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 42 }, "name": "connectionStrings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ConnectionStrings" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#DiskSizeGB" }, "remarks": "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.", "stability": "stable", "summary": "Storage capacity that the host's root volume possesses expressed in gigabytes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 49 }, "name": "diskSizeGb", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#EncryptionAtRestProvider" }, "remarks": "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.", "stability": "stable", "summary": "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 56 }, "name": "encryptionAtRestProvider", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsEncryptionAtRestProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#GlobalClusterSelfManagedSharding" }, "remarks": "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).", "stability": "stable", "summary": "(Optional) Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 63 }, "name": "globalClusterSelfManagedSharding", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#Labels" }, "remarks": "The MongoDB Cloud console doesn't display your labels.", "stability": "stable", "summary": "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 84 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsLabels" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#MongoDBMajorVersion" }, "remarks": "MongoDB Cloud deploys the cluster with the latest stable release of the specified version.", "stability": "stable", "summary": "Major MongoDB version of the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 91 }, "name": "mongoDbMajorVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#Paused" }, "stability": "stable", "summary": "Flag that indicates whether the cluster is paused or not." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 105 }, "name": "paused", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#PitEnabled" }, "stability": "stable", "summary": "Flag that indicates whether the cluster uses continuous cloud backups." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 112 }, "name": "pitEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 70 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#ReplicationSpecs" }, "remarks": "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.", "stability": "stable", "summary": "List of settings that configure your cluster regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 119 }, "name": "replicationSpecs", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AdvancedReplicationSpec" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#RootCertType" }, "remarks": "MongoDB Cloud supports Internet Security Research Group.", "stability": "stable", "summary": "Root Certificate Authority that MongoDB Cloud cluster uses." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 126 }, "name": "rootCertType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#Tags" }, "remarks": "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.", "stability": "stable", "summary": "List of settings that configure your cluster regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 147 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Tag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#TerminationProtectionEnabled" }, "remarks": "If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.", "stability": "stable", "summary": "Flag that indicates whether termination protection is enabled on the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 140 }, "name": "terminationProtectionEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterProps#VersionReleaseSystem" }, "remarks": "If value is CONTINUOUS, you must not specify mongoDBMajorVersion", "stability": "stable", "summary": "Method by which the cluster maintains the MongoDB versions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 133 }, "name": "versionReleaseSystem", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:CfnClusterProps" }, "awscdk-resources-mongodbatlas.CfnClusterPropsBiConnector": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnClusterPropsBiConnector" }, "stability": "stable", "summary": "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster." }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsBiConnector", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 312 }, "name": "CfnClusterPropsBiConnector", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnClusterPropsBiConnector#Enabled" }, "stability": "stable", "summary": "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 326 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterPropsBiConnector#ReadPreference" }, "default": "ANALYTICS node, or SECONDARY if there are no ANALYTICS nodes.", "remarks": "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.", "stability": "stable", "summary": "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 319 }, "name": "readPreference", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:CfnClusterPropsBiConnector" }, "awscdk-resources-mongodbatlas.CfnClusterPropsEncryptionAtRestProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnClusterPropsEncryptionAtRestProvider" }, "remarks": "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.", "stability": "stable", "summary": "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster." }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsEncryptionAtRestProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 440 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "NONE." }, "name": "NONE" } ], "name": "CfnClusterPropsEncryptionAtRestProvider", "symbolId": "src/l1-resources/cluster/index:CfnClusterPropsEncryptionAtRestProvider" }, "awscdk-resources-mongodbatlas.CfnClusterPropsLabels": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnClusterPropsLabels" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsLabels", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 454 }, "name": "CfnClusterPropsLabels", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnClusterPropsLabels#Key" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 458 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnClusterPropsLabels#Value" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 463 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:CfnClusterPropsLabels" }, "awscdk-resources-mongodbatlas.CfnCustomDbRole": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CustomDBRole" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CustomDBRole`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCustomDbRole", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CustomDBRole`." }, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 226 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCustomDbRoleProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 207 }, "name": "CfnCustomDbRole", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 211 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 217 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCustomDbRoleProps" } } ], "symbolId": "src/l1-resources/custom-db-role/index:CfnCustomDbRole" }, "awscdk-resources-mongodbatlas.CfnCustomDbRoleProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes custom database user privilege roles." }, "fqn": "awscdk-resources-mongodbatlas.CfnCustomDbRoleProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 10 }, "name": "CfnCustomDbRoleProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps#RoleName" }, "remarks": "This name must be unique for this custom role in this project.", "stability": "stable", "summary": "Human-readable label that identifies the role for the request." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 37 }, "name": "roleName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps#Actions" }, "stability": "stable", "summary": "List of the individual privilege actions that the role grants." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 23 }, "name": "actions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Action" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps#InheritedRoles" }, "stability": "stable", "summary": "List of the built-in roles that this custom role inherits." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 30 }, "name": "inheritedRoles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.InheritedRole" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDbRoleProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 44 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/custom-db-role/index:CfnCustomDbRoleProps" }, "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAws": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::CustomDnsConfigurationClusterAws" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::CustomDnsConfigurationClusterAws`." }, "fqn": "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAws", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::CustomDnsConfigurationClusterAws`." }, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 81 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAwsProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 62 }, "name": "CfnCustomDnsConfigurationClusterAws", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 66 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 72 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAwsProps" } } ], "symbolId": "src/l1-resources/custom-dns-configuration-cluster-aws/index:CfnCustomDnsConfigurationClusterAws" }, "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAwsProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnCustomDnsConfigurationClusterAwsProps" }, "stability": "stable", "summary": "An example resource schema demonstrating some basic constructs and validation rules." }, "fqn": "awscdk-resources-mongodbatlas.CfnCustomDnsConfigurationClusterAwsProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 10 }, "name": "CfnCustomDnsConfigurationClusterAwsProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDnsConfigurationClusterAwsProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDnsConfigurationClusterAwsProps#Enabled" }, "stability": "stable", "summary": "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 16 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnCustomDnsConfigurationClusterAwsProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-dns-configuration-cluster-aws/index.ts", "line": 30 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/custom-dns-configuration-cluster-aws/index:CfnCustomDnsConfigurationClusterAwsProps" }, "awscdk-resources-mongodbatlas.CfnDataLakePipeline": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::DataLakePipeline" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::DataLakePipeline`." }, "fqn": "awscdk-resources-mongodbatlas.CfnDataLakePipeline", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::DataLakePipeline`." }, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 356 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDataLakePipelineProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 324 }, "name": "CfnDataLakePipeline", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 328 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakePipeline.CreatedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 339 }, "name": "attrCreatedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakePipeline.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 343 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakePipeline.LastUpdatedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 347 }, "name": "attrLastUpdatedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 334 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDataLakePipelineProps" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:CfnDataLakePipeline" }, "awscdk-resources-mongodbatlas.CfnDataLakePipelineProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps" }, "remarks": "As of September 2024, Data Lake is deprecated. If you use Data Lake, you should migrate to alternative solutions before the service is removed. To learn more, see . This resource returns, adds, edits, and removes data lake pipelines.", "stability": "stable", "summary": "Data Lake is deprecated." }, "fqn": "awscdk-resources-mongodbatlas.CfnDataLakePipelineProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 10 }, "name": "CfnDataLakePipelineProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#Name" }, "stability": "stable", "summary": "Name of this Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 37 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#Sink" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 42 }, "name": "sink", "type": { "fqn": "awscdk-resources-mongodbatlas.Sink" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#Transformations" }, "stability": "stable", "summary": "Ingestion destination of a Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 54 }, "name": "transformations", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Transformations" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#Source" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 47 }, "name": "source", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Source" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakePipelineProps#State" }, "stability": "stable", "summary": "State of the Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 30 }, "name": "state", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:CfnDataLakePipelineProps" }, "awscdk-resources-mongodbatlas.CfnDataLakes": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::DataLakes" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::DataLakes`." }, "fqn": "awscdk-resources-mongodbatlas.CfnDataLakes", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::DataLakes`." }, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 716 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDataLakesProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 685 }, "name": "CfnDataLakes", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 689 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakes.Hostnames`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 703 }, "name": "attrHostnames", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakes.StartDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 699 }, "name": "attrStartDate", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DataLakes.State`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 707 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 694 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDataLakesProps" } } ], "symbolId": "src/l1-resources/datalakes/index:CfnDataLakes" }, "awscdk-resources-mongodbatlas.CfnDataLakesProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnDataLakesProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes Federated Database Instances." }, "fqn": "awscdk-resources-mongodbatlas.CfnDataLakesProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 10 }, "name": "CfnDataLakesProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#CloudProviderConfig" }, "stability": "stable", "summary": "Cloud provider linked to this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 16 }, "name": "cloudProviderConfig", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeCloudProviderConfigView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#DataProcessRegion" }, "remarks": "MongoDB Cloud supports AWS only.", "stability": "stable", "summary": "Information about the cloud provider region to which the data lake routes client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 23 }, "name": "dataProcessRegion", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#EndDate" }, "remarks": "MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", "stability": "stable", "summary": "Timestamp that specifies the end point for the range of log messages to download." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 30 }, "name": "endDate", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 44 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 37 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#SkipRoleValidation" }, "remarks": "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.", "stability": "stable", "summary": "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 51 }, "name": "skipRoleValidation", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#Storage" }, "stability": "stable", "summary": "Configuration information for each data store and its mapping to MongoDB Cloud databases." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 58 }, "name": "storage", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeStorageView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDataLakesProps#TenantName" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to remove." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 65 }, "name": "tenantName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/datalakes/index:CfnDataLakesProps" }, "awscdk-resources-mongodbatlas.CfnDatabaseUser": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::DatabaseUser" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::DatabaseUser`." }, "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUser", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::DatabaseUser`." }, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 327 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 303 }, "name": "CfnDatabaseUser", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 307 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::DatabaseUser.UserCFNIdentifier`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 318 }, "name": "attrUserCFNIdentifier", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 313 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserProps" } } ], "symbolId": "src/l1-resources/database-user/index:CfnDatabaseUser" }, "awscdk-resources-mongodbatlas.CfnDatabaseUserProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes database users." }, "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 10 }, "name": "CfnDatabaseUserProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#DatabaseName" }, "remarks": "MongoDB database users must provide both a username and authentication database to log into MongoDB. Default value is `admin`.", "stability": "stable", "summary": "MongoDB database against which the MongoDB database user authenticates." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 30 }, "name": "databaseName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your Atlas Project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 65 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Roles" }, "stability": "stable", "summary": "List that provides the pairings of one role with one applicable database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 72 }, "name": "roles", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.RoleDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Username" }, "remarks": "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.", "stability": "stable", "summary": "Human-readable label that represents the user that authenticates to MongoDB." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 86 }, "name": "username", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#AWSIAMType" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 23 }, "name": "awsiamType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsAwsiamType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#DeleteAfterDate" }, "remarks": "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.", "stability": "stable", "summary": "Date and time when MongoDB Cloud deletes the user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 16 }, "name": "deleteAfterDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Labels" }, "remarks": "The labels that you define do not appear in the console.", "stability": "stable", "summary": "List that contains the key-value pairs for tagging and categorizing the MongoDB database user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 37 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.LabelDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#LdapAuthType" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "Method by which the provided username is authenticated." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 44 }, "name": "ldapAuthType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsLdapAuthType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Password" }, "remarks": "This field is not included in the entity returned from the server.", "stability": "stable", "summary": "The user’s password." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 58 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 93 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#Scopes" }, "remarks": "If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.", "stability": "stable", "summary": "List that contains clusters and MongoDB Atlas Data Lakes that this database user can access." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 79 }, "name": "scopes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ScopeDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnDatabaseUserProps#X509Type" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "Method that briefs who owns the certificate provided." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 51 }, "name": "x509Type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsX509Type" } } ], "symbolId": "src/l1-resources/database-user/index:CfnDatabaseUserProps" }, "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsAwsiamType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnDatabaseUserPropsAwsiamType" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "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." }, "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsAwsiamType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 133 }, "members": [ { "docs": { "stability": "stable", "summary": "NONE." }, "name": "NONE" }, { "docs": { "stability": "stable", "summary": "USER." }, "name": "USER" }, { "docs": { "stability": "stable", "summary": "ROLE." }, "name": "ROLE" } ], "name": "CfnDatabaseUserPropsAwsiamType", "symbolId": "src/l1-resources/database-user/index:CfnDatabaseUserPropsAwsiamType" }, "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsLdapAuthType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnDatabaseUserPropsLdapAuthType" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "Method by which the provided username is authenticated." }, "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsLdapAuthType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 184 }, "members": [ { "docs": { "stability": "stable", "summary": "NONE." }, "name": "NONE" }, { "docs": { "stability": "stable", "summary": "USER." }, "name": "USER" }, { "docs": { "stability": "stable", "summary": "GROUP." }, "name": "GROUP" } ], "name": "CfnDatabaseUserPropsLdapAuthType", "symbolId": "src/l1-resources/database-user/index:CfnDatabaseUserPropsLdapAuthType" }, "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsX509Type": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnDatabaseUserPropsX509Type" }, "remarks": "Default value is `NONE`.", "stability": "stable", "summary": "Method that briefs who owns the certificate provided." }, "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsX509Type", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 198 }, "members": [ { "docs": { "stability": "stable", "summary": "NONE." }, "name": "NONE" }, { "docs": { "stability": "stable", "summary": "MANAGED." }, "name": "MANAGED" }, { "docs": { "stability": "stable", "summary": "CUSTOMER." }, "name": "CUSTOMER" } ], "name": "CfnDatabaseUserPropsX509Type", "symbolId": "src/l1-resources/database-user/index:CfnDatabaseUserPropsX509Type" }, "awscdk-resources-mongodbatlas.CfnEncryptionAtRest": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::EncryptionAtRest" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::EncryptionAtRest`." }, "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRest", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::EncryptionAtRest`." }, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 143 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRestProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 119 }, "name": "CfnEncryptionAtRest", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 123 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::EncryptionAtRest.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 134 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 129 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRestProps" } } ], "symbolId": "src/l1-resources/encryption-at-rest/index:CfnEncryptionAtRest" }, "awscdk-resources-mongodbatlas.CfnEncryptionAtRestProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps" }, "stability": "stable", "summary": "Returns and edits the Encryption at Rest using Customer Key Management configuration." }, "fqn": "awscdk-resources-mongodbatlas.CfnEncryptionAtRestProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 10 }, "name": "CfnEncryptionAtRestProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps#AwsKmsConfig" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 14 }, "name": "awsKmsConfig", "type": { "fqn": "awscdk-resources-mongodbatlas.AwsKmsConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps#ProjectId" }, "stability": "stable", "summary": "Unique identifier of the Atlas project to which the user belongs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 28 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnEncryptionAtRestProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/encryption-at-rest/index.ts", "line": 21 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/encryption-at-rest/index:CfnEncryptionAtRestProps" }, "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstance": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::FederatedDatabaseInstance" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::FederatedDatabaseInstance`." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstance", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::FederatedDatabaseInstance`." }, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 685 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstanceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 657 }, "name": "CfnFederatedDatabaseInstance", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 661 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 672 }, "name": "attrHostNames", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 676 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 667 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstanceProps" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:CfnFederatedDatabaseInstance" }, "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstanceProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes Federated Database Instances." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedDatabaseInstanceProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 10 }, "name": "CfnFederatedDatabaseInstanceProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 30 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#TenantName" }, "stability": "stable", "summary": "Human-readable label that identifies the data federation." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 37 }, "name": "tenantName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#CloudProviderConfig" }, "stability": "stable", "summary": "Cloud provider linked to this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 16 }, "name": "cloudProviderConfig", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CloudProviderConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#DataProcessRegion" }, "remarks": "MongoDB Cloud supports AWS only.", "stability": "stable", "summary": "Information about the cloud provider region to which the data lake routes client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 23 }, "name": "dataProcessRegion", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataProcessRegion" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 58 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#SkipRoleValidation" }, "remarks": "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.", "stability": "stable", "summary": "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 44 }, "name": "skipRoleValidation", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedDatabaseInstanceProps#Storage" }, "stability": "stable", "summary": "Configuration information for each data store and its mapping to MongoDB Cloud databases." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 51 }, "name": "storage", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Storage" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:CfnFederatedDatabaseInstanceProps" }, "awscdk-resources-mongodbatlas.CfnFederatedQueryLimit": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::FederatedQueryLimit" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::FederatedQueryLimit`." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimit", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::FederatedQueryLimit`." }, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 138 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 102 }, "name": "CfnFederatedQueryLimit", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 106 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 117 }, "name": "attrCurrentUsage", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 129 }, "name": "attrDefaultLimit", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 121 }, "name": "attrLastModifiedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 125 }, "name": "attrMaximumLimit", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 112 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitProps" } } ], "symbolId": "src/l1-resources/federated-query-limit/index:CfnFederatedQueryLimit" }, "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps" }, "stability": "stable", "summary": "Query limit for one federated database instance." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 10 }, "name": "CfnFederatedQueryLimitProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#LimitName" }, "stability": "stable", "summary": "Human-readable label that identifies this data federation instance limit." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 30 }, "name": "limitName", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitPropsLimitName" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#TenantName" }, "stability": "stable", "summary": "Human-readable label that identifies the data federated database instance to which the query limit applies." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 23 }, "name": "tenantName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#Value" }, "stability": "stable", "summary": "Amount to set the limit to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 44 }, "name": "value", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#OverrunPolicy" }, "remarks": "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. \"enum\" : [ \"BLOCK\", \"BLOCK_AND_KILL\" ]", "stability": "stable", "summary": "Only used for Data Federation limits." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 37 }, "name": "overrunPolicy", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedQueryLimitProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 51 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-query-limit/index:CfnFederatedQueryLimitProps" }, "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitPropsLimitName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnFederatedQueryLimitPropsLimitName" }, "stability": "stable", "summary": "Human-readable label that identifies this data federation instance limit." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedQueryLimitPropsLimitName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/federated-query-limit/index.ts", "line": 85 }, "members": [ { "docs": { "stability": "stable", "summary": "bytesProcessed.query." }, "name": "BYTES_PROCESSED_QUERY" }, { "docs": { "stability": "stable", "summary": "bytesProcessed.daily." }, "name": "BYTES_PROCESSED_DAILY" }, { "docs": { "stability": "stable", "summary": "bytesProcessed.weekly." }, "name": "BYTES_PROCESSED_WEEKLY" }, { "docs": { "stability": "stable", "summary": "bytesProcessed.monthly." }, "name": "BYTES_PROCESSED_MONTHLY" } ], "name": "CfnFederatedQueryLimitPropsLimitName", "symbolId": "src/l1-resources/federated-query-limit/index:CfnFederatedQueryLimitPropsLimitName" }, "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMapping": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::FederatedSettingsOrgRoleMapping" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMapping", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`." }, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 153 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMappingProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 129 }, "name": "CfnFederatedSettingsOrgRoleMapping", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 133 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 144 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 139 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMappingProps" } } ], "symbolId": "src/l1-resources/federated-settings-org-role-mapping/index:CfnFederatedSettingsOrgRoleMapping" }, "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMappingProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations." }, "fqn": "awscdk-resources-mongodbatlas.CfnFederatedSettingsOrgRoleMappingProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 10 }, "name": "CfnFederatedSettingsOrgRoleMappingProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps#ExternalGroupName" }, "stability": "stable", "summary": "Unique human-readable label that identifies the identity provider group to whichthis role mapping applies." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 23 }, "name": "externalGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps#FederationSettingsId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your federation." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 30 }, "name": "federationSettingsId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps#OrgId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 37 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnFederatedSettingsOrgRoleMappingProps#RoleAssignments" }, "stability": "stable", "summary": "Atlas roles and the unique identifiers of the groups and organizations associated with each role." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 44 }, "name": "roleAssignments", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.RoleAssignment" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/federated-settings-org-role-mapping/index:CfnFederatedSettingsOrgRoleMappingProps" }, "awscdk-resources-mongodbatlas.CfnGlobalClusterConfig": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::GlobalClusterConfig" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::GlobalClusterConfig`." }, "fqn": "awscdk-resources-mongodbatlas.CfnGlobalClusterConfig", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::GlobalClusterConfig`." }, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 216 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnGlobalClusterConfigProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 192 }, "name": "CfnGlobalClusterConfig", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 196 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 207 }, "name": "attrRemoveAllZoneMapping", "type": { "fqn": "aws-cdk-lib.IResolvable" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 202 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnGlobalClusterConfigProps" } } ], "symbolId": "src/l1-resources/global-cluster-config/index:CfnGlobalClusterConfig" }, "awscdk-resources-mongodbatlas.CfnGlobalClusterConfigProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps" }, "remarks": "This resource can only be used with Atlas-managed clusters, see doc for `GlobalClusterSelfManagedSharding` attribute in `Mongodb::Atlas::Cluster` resource for more info.", "stability": "stable", "summary": "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings." }, "fqn": "awscdk-resources-mongodbatlas.CfnGlobalClusterConfigProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 10 }, "name": "CfnGlobalClusterConfigProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps#ClusterName" }, "stability": "stable", "summary": "The name of the Atlas cluster that contains the snapshots you want to retrieve." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 30 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps#CustomZoneMappings" }, "remarks": "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.\n\nThis parameter returns an empty object if no custom zones exist.", "stability": "stable", "summary": "List that contains comma-separated key value pairs to map zones to geographic regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 48 }, "name": "customZoneMappings", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ZoneMapping" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps#ManagedNamespaces" }, "remarks": "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.\n\nThis parameter returns an empty object if no custom zones exist.", "stability": "stable", "summary": "List that contains comma-separated key value pairs to map zones to geographic regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 39 }, "name": "managedNamespaces", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ManagedNamespace" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnGlobalClusterConfigProps#ProjectId" }, "stability": "stable", "summary": "The unique identifier of the project for the Atlas cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 23 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/global-cluster-config/index:CfnGlobalClusterConfigProps" }, "awscdk-resources-mongodbatlas.CfnLdapConfiguration": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::LDAPConfiguration" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::LDAPConfiguration`." }, "fqn": "awscdk-resources-mongodbatlas.CfnLdapConfiguration", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::LDAPConfiguration`." }, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 204 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnLdapConfigurationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 185 }, "name": "CfnLdapConfiguration", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 189 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 195 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnLdapConfigurationProps" } } ], "symbolId": "src/l1-resources/ldap-configuration/index:CfnLdapConfiguration" }, "awscdk-resources-mongodbatlas.CfnLdapConfigurationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps" }, "stability": "stable", "summary": "Returns, edits, verifies, and removes LDAP configurations." }, "fqn": "awscdk-resources-mongodbatlas.CfnLdapConfigurationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 10 }, "name": "CfnLdapConfigurationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#BindPassword" }, "stability": "stable", "summary": "Password that MongoDB Cloud uses to authenticate the **bindUsername**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 72 }, "name": "bindPassword", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#BindUsername" }, "remarks": "LDAP distinguished names must be formatted according to RFC 2253.", "stability": "stable", "summary": "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 23 }, "name": "bindUsername", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#Hostname" }, "remarks": "This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", "stability": "stable", "summary": "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 37 }, "name": "hostname", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#Port" }, "stability": "stable", "summary": "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 86 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 79 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#AuthenticationEnabled" }, "stability": "stable", "summary": "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 44 }, "name": "authenticationEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#AuthorizationEnabled" }, "stability": "stable", "summary": "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 51 }, "name": "authorizationEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#AuthzQueryTemplate" }, "remarks": "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).", "stability": "stable", "summary": "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 65 }, "name": "authzQueryTemplate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#CaCertificate" }, "remarks": "MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`", "stability": "stable", "summary": "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 58 }, "name": "caCertificate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#Status" }, "stability": "stable", "summary": "The current status of the LDAP over TLS/SSL configuration." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 30 }, "name": "status", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapConfigurationProps#UserToDNMapping" }, "stability": "stable", "summary": "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-configuration/index.ts", "line": 93 }, "name": "userToDnMapping", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasNdsUserToDnMappingView" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/ldap-configuration/index:CfnLdapConfigurationProps" }, "awscdk-resources-mongodbatlas.CfnLdapVerify": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::LDAPVerify" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::LDAPVerify`." }, "fqn": "awscdk-resources-mongodbatlas.CfnLdapVerify", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::LDAPVerify`." }, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 174 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnLdapVerifyProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 147 }, "name": "CfnLdapVerify", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 151 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::LDAPVerify.RequestId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 161 }, "name": "attrRequestId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::LDAPVerify.Status`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 165 }, "name": "attrStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 156 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnLdapVerifyProps" } } ], "symbolId": "src/l1-resources/ldap-verify/index:CfnLdapVerify" }, "awscdk-resources-mongodbatlas.CfnLdapVerifyProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps" }, "remarks": "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.", "stability": "stable", "summary": "Requests a verification of an LDAP configuration over TLS for an Atlas project." }, "fqn": "awscdk-resources-mongodbatlas.CfnLdapVerifyProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 10 }, "name": "CfnLdapVerifyProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#BindPassword" }, "stability": "stable", "summary": "Password that MongoDB Cloud uses to authenticate the **bindUsername**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 58 }, "name": "bindPassword", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#BindUsername" }, "remarks": "LDAP distinguished names must be formatted according to RFC 2253.", "stability": "stable", "summary": "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 30 }, "name": "bindUsername", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#HostName" }, "remarks": "This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", "stability": "stable", "summary": "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 37 }, "name": "hostName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#Port" }, "stability": "stable", "summary": "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 72 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 65 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#AuthzQueryTemplate" }, "remarks": "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).", "stability": "stable", "summary": "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 51 }, "name": "authzQueryTemplate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#CaCertificate" }, "remarks": "MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`", "stability": "stable", "summary": "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 44 }, "name": "caCertificate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnLdapVerifyProps#Validations" }, "remarks": "The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure.", "stability": "stable", "summary": "List of validation messages related to the verification of the provided LDAP over TLS configuration details." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 23 }, "name": "validations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Validation" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/ldap-verify/index:CfnLdapVerifyProps" }, "awscdk-resources-mongodbatlas.CfnMaintenanceWindow": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::MaintenanceWindow" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::MaintenanceWindow`." }, "fqn": "awscdk-resources-mongodbatlas.CfnMaintenanceWindow", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::MaintenanceWindow`." }, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 116 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnMaintenanceWindowProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 97 }, "name": "CfnMaintenanceWindow", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 101 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 107 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnMaintenanceWindowProps" } } ], "symbolId": "src/l1-resources/maintenance-window/index:CfnMaintenanceWindow" }, "awscdk-resources-mongodbatlas.CfnMaintenanceWindowProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps" }, "stability": "stable", "summary": "The maintenanceWindow resource provides access to retrieve or update the current Atlas project maintenance window." }, "fqn": "awscdk-resources-mongodbatlas.CfnMaintenanceWindowProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 10 }, "name": "CfnMaintenanceWindowProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#HourOfDay" }, "remarks": "Use `0` for midnight and `12` for noon.", "stability": "stable", "summary": "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 55 }, "name": "hourOfDay", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#AutoDeferOnceEnabled" }, "stability": "stable", "summary": "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 23 }, "name": "autoDeferOnceEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#DayOfWeek" }, "remarks": "| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |", "stability": "stable", "summary": "One-based integer that represents the day of the week that the maintenance window starts." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 41 }, "name": "dayOfWeek", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml)", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 48 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnMaintenanceWindowProps#StartASAP" }, "remarks": "To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance.", "stability": "stable", "summary": "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/maintenance-window/index.ts", "line": 62 }, "name": "startAsap", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/maintenance-window/index:CfnMaintenanceWindowProps" }, "awscdk-resources-mongodbatlas.CfnNetworkContainer": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::NetworkContainer" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::NetworkContainer`." }, "fqn": "awscdk-resources-mongodbatlas.CfnNetworkContainer", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::NetworkContainer`." }, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 116 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnNetworkContainerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 92 }, "name": "CfnNetworkContainer", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 96 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::NetworkContainer.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 107 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 102 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnNetworkContainerProps" } } ], "symbolId": "src/l1-resources/network-container/index:CfnNetworkContainer" }, "awscdk-resources-mongodbatlas.CfnNetworkContainerProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes network peering containers." }, "fqn": "awscdk-resources-mongodbatlas.CfnNetworkContainerProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 10 }, "name": "CfnNetworkContainerProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#AtlasCidrBlock" }, "remarks": "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.\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS further limits the block to between the /24 and /21 ranges.\nTo modify the CIDR block, the target project cannot have:\n- Any M10 or greater clusters\n- Any other VPC peering connections\nYou 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.\nExample: 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.", "stability": "stable", "summary": "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 50 }, "name": "atlasCidrBlock", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#RegionName" }, "stability": "stable", "summary": "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 23 }, "name": "regionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 57 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#Provisioned" }, "stability": "stable", "summary": "Boolean flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 30 }, "name": "provisioned", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkContainerProps#VpcId" }, "stability": "stable", "summary": "Unique string that identifies the MongoDB Cloud VPC on AWS." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-container/index.ts", "line": 37 }, "name": "vpcId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/network-container/index:CfnNetworkContainerProps" }, "awscdk-resources-mongodbatlas.CfnNetworkPeering": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::NetworkPeering" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::NetworkPeering`." }, "fqn": "awscdk-resources-mongodbatlas.CfnNetworkPeering", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::NetworkPeering`." }, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 130 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnNetworkPeeringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 94 }, "name": "CfnNetworkPeering", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 98 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 121 }, "name": "attrConnectionId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 117 }, "name": "attrErrorStateName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::NetworkPeering.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 109 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::NetworkPeering.StatusName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 113 }, "name": "attrStatusName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 104 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnNetworkPeeringProps" } } ], "symbolId": "src/l1-resources/network-peering/index:CfnNetworkPeering" }, "awscdk-resources-mongodbatlas.CfnNetworkPeeringProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes network peering containers and peering connections." }, "fqn": "awscdk-resources-mongodbatlas.CfnNetworkPeeringProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 10 }, "name": "CfnNetworkPeeringProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#ContainerId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 23 }, "name": "containerId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#VpcId" }, "stability": "stable", "summary": "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 51 }, "name": "vpcId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#AccepterRegionName" }, "remarks": "The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region.", "stability": "stable", "summary": "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 30 }, "name": "accepterRegionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#AwsAccountId" }, "stability": "stable", "summary": "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 37 }, "name": "awsAccountId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 58 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnNetworkPeeringProps#RouteTableCIDRBlock" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/network-peering/index.ts", "line": 44 }, "name": "routeTableCidrBlock", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/network-peering/index:CfnNetworkPeeringProps" }, "awscdk-resources-mongodbatlas.CfnOnlineArchive": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::OnlineArchive" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::OnlineArchive`." }, "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchive", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::OnlineArchive`." }, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 415 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchiveProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 383 }, "name": "CfnOnlineArchive", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 387 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 406 }, "name": "attrArchiveId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OnlineArchive.State`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 398 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 402 }, "name": "attrTotalCount", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 393 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchiveProps" } } ], "symbolId": "src/l1-resources/online-archive/index:CfnOnlineArchive" }, "awscdk-resources-mongodbatlas.CfnOnlineArchiveProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps" }, "stability": "stable", "summary": "Returns, adds, edits, or removes an online archive." }, "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchiveProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 10 }, "name": "CfnOnlineArchiveProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#ClusterName" }, "stability": "stable", "summary": "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 23 }, "name": "clusterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#Criteria" }, "remarks": "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.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", "stability": "stable", "summary": "Rules by which MongoDB MongoDB Cloud archives data." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 50 }, "name": "criteria", "type": { "fqn": "awscdk-resources-mongodbatlas.CriteriaView" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#CollectionType" }, "remarks": "If you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", "stability": "stable", "summary": "Classification of MongoDB database collection that you want to return." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 39 }, "name": "collectionType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchivePropsCollectionType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#CollName" }, "stability": "stable", "summary": "Human-readable label that identifies the collection for which you created the online archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 30 }, "name": "collName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#DbName" }, "stability": "stable", "summary": "Human-readable label of the database that contains the collection that contains the online archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 57 }, "name": "dbName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#IncludeCount" }, "stability": "stable", "summary": "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 71 }, "name": "includeCount", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#ItemsPerPage" }, "stability": "stable", "summary": "Number of items that the response returns per page." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 78 }, "name": "itemsPerPage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 85 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#PartitionFields" }, "remarks": "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.", "stability": "stable", "summary": "List that contains document parameters to use to logically divide data within a collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 92 }, "name": "partitionFields", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.PartitionFieldView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 64 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOnlineArchiveProps#Schedule" }, "stability": "stable", "summary": "Regular frequency and duration when archiving process occurs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 99 }, "name": "schedule", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ScheduleView" } } ], "symbolId": "src/l1-resources/online-archive/index:CfnOnlineArchiveProps" }, "awscdk-resources-mongodbatlas.CfnOnlineArchivePropsCollectionType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnOnlineArchivePropsCollectionType" }, "remarks": "If you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", "stability": "stable", "summary": "Classification of MongoDB database collection that you want to return." }, "fqn": "awscdk-resources-mongodbatlas.CfnOnlineArchivePropsCollectionType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 143 }, "members": [ { "docs": { "stability": "stable", "summary": "STANDARD." }, "name": "STANDARD" }, { "docs": { "stability": "stable", "summary": "TIMESERIES." }, "name": "TIMESERIES" } ], "name": "CfnOnlineArchivePropsCollectionType", "symbolId": "src/l1-resources/online-archive/index:CfnOnlineArchivePropsCollectionType" }, "awscdk-resources-mongodbatlas.CfnOrgInvitation": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::OrgInvitation" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::OrgInvitation`." }, "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitation", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::OrgInvitation`." }, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 190 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 154 }, "name": "CfnOrgInvitation", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 158 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 177 }, "name": "attrCreatedAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 169 }, "name": "attrExpiresAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OrgInvitation.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 173 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 181 }, "name": "attrInviterUsername", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 164 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitationProps" } } ], "symbolId": "src/l1-resources/org-invitation/index:CfnOrgInvitation" }, "awscdk-resources-mongodbatlas.CfnOrgInvitationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps" }, "stability": "stable", "summary": "Returns, adds, and edits organizational units in MongoDB Cloud." }, "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 10 }, "name": "CfnOrgInvitationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 16 }, "name": "profile", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#IncludeCount" }, "stability": "stable", "summary": "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 23 }, "name": "includeCount", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#InvitationId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the invitation." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 30 }, "name": "invitationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#ItemsPerPage" }, "stability": "stable", "summary": "Number of items that the response returns per page." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 37 }, "name": "itemsPerPage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#OrgId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 44 }, "name": "orgId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#OrgName" }, "stability": "stable", "summary": "Human-readable label that identifies this organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 51 }, "name": "orgName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 58 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#Roles" }, "stability": "stable", "summary": "One or more organization or project level roles to assign to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 65 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitationPropsRoles" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#TeamIds" }, "stability": "stable", "summary": "List of unique 24-hexadecimal digit strings that identifies each team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 72 }, "name": "teamIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#TotalCount" }, "stability": "stable", "summary": "Number of documents returned in this response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 79 }, "name": "totalCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrgInvitationProps#Username" }, "stability": "stable", "summary": "Email address of the MongoDB Cloud user invited to join the organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 86 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/org-invitation/index:CfnOrgInvitationProps" }, "awscdk-resources-mongodbatlas.CfnOrgInvitationPropsRoles": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnOrgInvitationPropsRoles" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CfnOrgInvitationPropsRoles", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/org-invitation/index.ts", "line": 123 }, "members": [ { "docs": { "stability": "stable", "summary": "ORG_OWNER." }, "name": "ORG_OWNER" }, { "docs": { "stability": "stable", "summary": "ORG_MEMBER." }, "name": "ORG_MEMBER" }, { "docs": { "stability": "stable", "summary": "ORG_GROUP_CREATOR." }, "name": "ORG_GROUP_CREATOR" }, { "docs": { "stability": "stable", "summary": "ORG_BILLING_ADMIN." }, "name": "ORG_BILLING_ADMIN" }, { "docs": { "stability": "stable", "summary": "ORG_READ_ONLY." }, "name": "ORG_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_CLUSTER_MANAGER." }, "name": "GROUP_CLUSTER_MANAGER" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_ADMIN." }, "name": "GROUP_DATA_ACCESS_ADMIN" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_ONLY." }, "name": "GROUP_DATA_ACCESS_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_WRITE." }, "name": "GROUP_DATA_ACCESS_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "GROUP_OWNER." }, "name": "GROUP_OWNER" }, { "docs": { "stability": "stable", "summary": "GROUP_READ_ONLY." }, "name": "GROUP_READ_ONLY" } ], "name": "CfnOrgInvitationPropsRoles", "symbolId": "src/l1-resources/org-invitation/index:CfnOrgInvitationPropsRoles" }, "awscdk-resources-mongodbatlas.CfnOrganization": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Organization" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Organization`." }, "fqn": "awscdk-resources-mongodbatlas.CfnOrganization", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Organization`." }, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 198 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOrganizationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 174 }, "name": "CfnOrganization", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 178 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Organization.OrgId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 189 }, "name": "attrOrgId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 184 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnOrganizationProps" } } ], "symbolId": "src/l1-resources/organization/index:CfnOrganization" }, "awscdk-resources-mongodbatlas.CfnOrganizationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnOrganizationProps" }, "stability": "stable", "summary": "Returns, adds, and edits organizational units in MongoDB Cloud." }, "fqn": "awscdk-resources-mongodbatlas.CfnOrganizationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 10 }, "name": "CfnOrganizationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#AwsSecretName" }, "stability": "stable", "summary": "AwsSecretName used to set newly created Org credentials information." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 49 }, "name": "awsSecretName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 16 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#OrgOwnerId" }, "remarks": "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.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 35 }, "name": "orgOwnerId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#ApiAccessListRequired" }, "stability": "stable", "summary": "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 78 }, "name": "apiAccessListRequired", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#APIKey" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 21 }, "name": "apiKey", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiKey" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#FederatedSettingsId" }, "remarks": "If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 28 }, "name": "federatedSettingsId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#GenAIFeaturesEnabled" }, "remarks": "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/", "stability": "stable", "summary": "Flag that indicates whether this organization has access to generative AI features." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 64 }, "name": "genAiFeaturesEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#IsDeleted" }, "stability": "stable", "summary": "Flag that indicates whether this organization has been deleted." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 71 }, "name": "isDeleted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#MultiFactorAuthRequired" }, "remarks": "To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.", "stability": "stable", "summary": "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 85 }, "name": "multiFactorAuthRequired", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 42 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#RestrictEmployeeAccess" }, "remarks": "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/.", "stability": "stable", "summary": "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 92 }, "name": "restrictEmployeeAccess", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnOrganizationProps#SkipDefaultAlertsSettings" }, "default": "true` for new Atlas Organizations created with the provider to prevent infrastructure drift caused by creation of new alerts.", "remarks": "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.", "stability": "stable", "summary": "Disables automatic alert creation." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/organization/index.ts", "line": 57 }, "name": "skipDefaultAlertsSettings", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/organization/index:CfnOrganizationProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalMode": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivateEndPointRegionalMode" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivateEndPointRegionalMode`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalMode", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivateEndPointRegionalMode`." }, "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 73 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalModeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 54 }, "name": "CfnPrivateEndPointRegionalMode", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 58 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 64 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalModeProps" } } ], "symbolId": "src/l1-resources/private-endpoint-regional-mode/index:CfnPrivateEndPointRegionalMode" }, "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalModeProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivateEndPointRegionalModeProps" }, "stability": "stable", "summary": "An example resource schema demonstrating some basic constructs and validation rules." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndPointRegionalModeProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 10 }, "name": "CfnPrivateEndPointRegionalModeProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndPointRegionalModeProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndPointRegionalModeProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-regional-mode/index.ts", "line": 23 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint-regional-mode/index:CfnPrivateEndPointRegionalModeProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivateEndpoint" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivateEndpoint`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpoint", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivateEndpoint`." }, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 189 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 161 }, "name": "CfnPrivateEndpoint", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 165 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpoint.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 176 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 180 }, "name": "attrInterfaceEndpoints", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 171 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointProps" } } ], "symbolId": "src/l1-resources/private-endpoint/index:CfnPrivateEndpoint" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdl": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivateEndpointADL" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivateEndpointADL`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdl", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivateEndpointADL`." }, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 105 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdlProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 86 }, "name": "CfnPrivateEndpointAdl", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 90 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 96 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdlProps" } } ], "symbolId": "src/l1-resources/private-endpoint-adl/index:CfnPrivateEndpointAdl" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdlProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps" }, "remarks": "To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.", "stability": "stable", "summary": "Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAdlProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 10 }, "name": "CfnPrivateEndpointAdlProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#Provider" }, "remarks": "Atlas Data Lake supports Amazon Web Services only.", "stability": "stable", "summary": "Human-readable label that identifies the cloud service provider." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 44 }, "name": "provider", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#Comment" }, "stability": "stable", "summary": "Human-readable string to associate with this private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 30 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#EndpointId" }, "stability": "stable", "summary": "Unique 22-character alphanumeric string that identifies the private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 37 }, "name": "endpointId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAdlProps#Type" }, "stability": "stable", "summary": "Human-readable label that identifies the resource type associated with this private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-adl/index.ts", "line": 51 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint-adl/index:CfnPrivateEndpointAdlProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointAws": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivateEndpointAWS" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAws", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivateEndpointAWS`." }, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 113 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAwsProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 94 }, "name": "CfnPrivateEndpointAws", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 98 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 104 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAwsProps" } } ], "symbolId": "src/l1-resources/private-endpoint-aws/index:CfnPrivateEndpointAws" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointAwsProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps" }, "remarks": "At this current version only AWS is supported", "stability": "stable", "summary": "Creates one private endpoint for the specified cloud service provider." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointAwsProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 10 }, "name": "CfnPrivateEndpointAwsProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#EndpointServiceId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 30 }, "name": "endpointServiceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#ConnectionStatus" }, "stability": "stable", "summary": "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 51 }, "name": "connectionStatus", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#EnforceConnectionSuccess" }, "stability": "stable", "summary": "If this proper is set to TRUE, the cloud formation resource will return success Only if the private connection is Succeeded." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 44 }, "name": "enforceConnectionSuccess", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#ErrorMessage" }, "remarks": "The resource returns null if the request succeeded.", "stability": "stable", "summary": "Error message returned when requesting private connection resource." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 58 }, "name": "errorMessage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#Id" }, "remarks": "for AWS is the VPC endpoint ID, example: vpce-xxxxxxxx", "stability": "stable", "summary": "Unique string that identifies the private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 37 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointAwsProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml)", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-aws/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint-aws/index:CfnPrivateEndpointAwsProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps" }, "remarks": "Atlas Private Endpoint Service 2. Aws VPC private Endpoint 3. Atlas Private Endpoint", "stability": "stable", "summary": "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." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 10 }, "name": "CfnPrivateEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#GroupId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 44 }, "name": "groupId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#Region" }, "stability": "stable", "summary": "Aws Region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 51 }, "name": "region", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#EndpointServiceName" }, "remarks": "Atlas returns null while it is creating the endpoint service.", "stability": "stable", "summary": "Name of the AWS PrivateLink endpoint service." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 23 }, "name": "endpointServiceName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#ErrorMessage" }, "remarks": "Returns null if there are no errors.", "stability": "stable", "summary": "Error message pertaining to the AWS PrivateLink connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 30 }, "name": "errorMessage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#PrivateEndpoints" }, "stability": "stable", "summary": "List of private endpoint associated to the service." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 58 }, "name": "privateEndpoints", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.PrivateEndpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml)", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointProps#Status" }, "stability": "stable", "summary": "Status of the Atlas PrivateEndpoint service connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 37 }, "name": "status", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint/index:CfnPrivateEndpointProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointService": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivateEndpointService" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivateEndpointService`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointService", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivateEndpointService`." }, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 124 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointServiceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 84 }, "name": "CfnPrivateEndpointService", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 88 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 103 }, "name": "attrEndpointServiceName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 107 }, "name": "attrErrorMessage", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpointService.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 99 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 115 }, "name": "attrInterfaceEndpoints", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::PrivateEndpointService.Status`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 111 }, "name": "attrStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 94 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointServiceProps" } } ], "symbolId": "src/l1-resources/private-endpoint-service/index:CfnPrivateEndpointService" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointServiceProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivateEndpointServiceProps" }, "remarks": "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.", "stability": "stable", "summary": "Creates one private endpoint service for the specified cloud service provider." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointServiceProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 10 }, "name": "CfnPrivateEndpointServiceProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointServiceProps#CloudProvider" }, "stability": "stable", "summary": "Cloud service provider that manages this private endpoint, default : AWS." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 37 }, "name": "cloudProvider", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointServicePropsCloudProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointServiceProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 23 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointServiceProps#Region" }, "stability": "stable", "summary": "Aws Region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 30 }, "name": "region", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivateEndpointServiceProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml)", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint-service/index:CfnPrivateEndpointServiceProps" }, "awscdk-resources-mongodbatlas.CfnPrivateEndpointServicePropsCloudProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnPrivateEndpointServicePropsCloudProvider" }, "stability": "stable", "summary": "Cloud service provider that manages this private endpoint, default : AWS." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivateEndpointServicePropsCloudProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/private-endpoint-service/index.ts", "line": 69 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" } ], "name": "CfnPrivateEndpointServicePropsCloudProvider", "symbolId": "src/l1-resources/private-endpoint-service/index:CfnPrivateEndpointServicePropsCloudProvider" }, "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchive": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchive", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`." }, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 99 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 80 }, "name": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchive", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 84 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 90 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps" } } ], "symbolId": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index:CfnPrivatelinkEndpointServiceDataFederationOnlineArchive" }, "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps" }, "stability": "stable", "summary": "Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects." }, "fqn": "awscdk-resources-mongodbatlas.CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 10 }, "name": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#EndpointId" }, "remarks": "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", "stability": "stable", "summary": "Unique 22-character alphanumeric string that identifies the private endpoint.Reg ex ^vpce-[0-9a-f]{17}$ ." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 32 }, "name": "endpointId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#Comment" }, "stability": "stable", "summary": "Human-readable string to associate with this private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 46 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 23 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#Type" }, "stability": "stable", "summary": "Human-readable label that identifies the resource type associated with this private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts", "line": 39 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index:CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps" }, "awscdk-resources-mongodbatlas.CfnProject": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Project" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Project`." }, "fqn": "awscdk-resources-mongodbatlas.CfnProject", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Project`." }, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 301 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 270 }, "name": "CfnProject", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 274 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Project.ClusterCount`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 292 }, "name": "attrClusterCount", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Project.Created`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 288 }, "name": "attrCreated", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Project.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 284 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 279 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectProps" } } ], "symbolId": "src/l1-resources/project/index:CfnProject" }, "awscdk-resources-mongodbatlas.CfnProjectInvitation": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ProjectInvitation" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ProjectInvitation`." }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitation", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ProjectInvitation`." }, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 148 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 112 }, "name": "CfnProjectInvitation", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 116 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 135 }, "name": "attrCreatedAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 127 }, "name": "attrExpiresAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ProjectInvitation.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 131 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 139 }, "name": "attrInviterUsername", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 122 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitationProps" } } ], "symbolId": "src/l1-resources/project-invitation/index:CfnProjectInvitation" }, "awscdk-resources-mongodbatlas.CfnProjectInvitationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps" }, "stability": "stable", "summary": "Returns, adds, and edits collections of clusters and users in MongoDB Cloud." }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 10 }, "name": "CfnProjectInvitationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#InvitationId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the invitation." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 44 }, "name": "invitationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 37 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 23 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#Roles" }, "stability": "stable", "summary": "One or more organization or project level roles to assign to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 51 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitationPropsRoles" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#TotalCount" }, "stability": "stable", "summary": "Number of documents returned in this response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 30 }, "name": "totalCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectInvitationProps#Username" }, "stability": "stable", "summary": "Email address of the user account invited to this project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 58 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/project-invitation/index:CfnProjectInvitationProps" }, "awscdk-resources-mongodbatlas.CfnProjectInvitationPropsRoles": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnProjectInvitationPropsRoles" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectInvitationPropsRoles", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/project-invitation/index.ts", "line": 91 }, "members": [ { "docs": { "stability": "stable", "summary": "GROUP_CLUSTER_MANAGER." }, "name": "GROUP_CLUSTER_MANAGER" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_ADMIN." }, "name": "GROUP_DATA_ACCESS_ADMIN" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_ONLY." }, "name": "GROUP_DATA_ACCESS_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_WRITE." }, "name": "GROUP_DATA_ACCESS_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "GROUP_OWNER." }, "name": "GROUP_OWNER" }, { "docs": { "stability": "stable", "summary": "GROUP_READ_ONLY." }, "name": "GROUP_READ_ONLY" } ], "name": "CfnProjectInvitationPropsRoles", "symbolId": "src/l1-resources/project-invitation/index:CfnProjectInvitationPropsRoles" }, "awscdk-resources-mongodbatlas.CfnProjectIpAccessList": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ProjectIpAccessList" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ProjectIpAccessList`." }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessList", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ProjectIpAccessList`." }, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 212 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessListProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 188 }, "name": "CfnProjectIpAccessList", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 192 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 203 }, "name": "attrTotalCount", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 198 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessListProps" } } ], "symbolId": "src/l1-resources/project-ip-access-list/index:CfnProjectIpAccessList" }, "awscdk-resources-mongodbatlas.CfnProjectIpAccessListProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnProjectIpAccessListProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes network access limits to database deployments in Atlas." }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectIpAccessListProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 10 }, "name": "CfnProjectIpAccessListProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnProjectIpAccessListProps#AccessList" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 14 }, "name": "accessList", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AccessListDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectIpAccessListProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 21 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectIpAccessListProps#ListOptions" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 33 }, "name": "listOptions", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ListOptions" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectIpAccessListProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 28 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/project-ip-access-list/index:CfnProjectIpAccessListProps" }, "awscdk-resources-mongodbatlas.CfnProjectProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnProjectProps" }, "stability": "stable", "summary": "Retrieves or creates projects in any given Atlas organization." }, "fqn": "awscdk-resources-mongodbatlas.CfnProjectProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 10 }, "name": "CfnProjectProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#Name" }, "stability": "stable", "summary": "Name of the project to create." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 16 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#OrgId" }, "stability": "stable", "summary": "Unique identifier of the organization within which to create the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 23 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 49 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#ProjectApiKeys" }, "stability": "stable", "summary": "API keys that you assigned to the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 63 }, "name": "projectApiKeys", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ProjectApiKey" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#ProjectOwnerId" }, "stability": "stable", "summary": "Unique identifier of the organization within which to create the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 30 }, "name": "projectOwnerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#ProjectSettings" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 42 }, "name": "projectSettings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ProjectSettings" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#ProjectTeams" }, "stability": "stable", "summary": "Teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 56 }, "name": "projectTeams", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ProjectTeam" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#RegionUsageRestrictions" }, "stability": "stable", "summary": "Region usage restrictions that designate the project's AWS region.Enum: \"GOV_REGIONS_ONLY\" \"COMMERCIAL_FEDRAMP_REGIONS_ONLY\" \"NONE\"." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 70 }, "name": "regionUsageRestrictions", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#Tags" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 75 }, "name": "tags", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnProjectProps#WithDefaultAlertsSettings" }, "stability": "stable", "summary": "Flag that indicates whether to create the project with default alert settings." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 37 }, "name": "withDefaultAlertsSettings", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/project/index:CfnProjectProps" }, "awscdk-resources-mongodbatlas.CfnResourcePolicy": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ResourcePolicy" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ResourcePolicy`." }, "fqn": "awscdk-resources-mongodbatlas.CfnResourcePolicy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ResourcePolicy`." }, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 204 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnResourcePolicyProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 168 }, "name": "CfnResourcePolicy", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 172 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 183 }, "name": "attrCreatedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ResourcePolicy.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 187 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 191 }, "name": "attrLastUpdatedDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ResourcePolicy.Version`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 195 }, "name": "attrVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 178 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnResourcePolicyProps" } } ], "symbolId": "src/l1-resources/resource-policy/index:CfnResourcePolicy" }, "awscdk-resources-mongodbatlas.CfnResourcePolicyProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps" }, "stability": "stable", "summary": "Atlas Resource Policies." }, "fqn": "awscdk-resources-mongodbatlas.CfnResourcePolicyProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 10 }, "name": "CfnResourcePolicyProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#Name" }, "stability": "stable", "summary": "Human-readable label that describes the atlas resource policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 30 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#OrgId" }, "remarks": "Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 37 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#Policies" }, "stability": "stable", "summary": "List of policies that make up the atlas resource policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 44 }, "name": "policies", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasPolicy" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#CreatedByUser" }, "stability": "stable", "summary": "The user that last updated the atlas resource policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 16 }, "name": "createdByUser", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasUserMetadata" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#LastUpdatedByUser" }, "stability": "stable", "summary": "The user that last updated the atlas resource policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 23 }, "name": "lastUpdatedByUser", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasUserMetadata" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnResourcePolicyProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/resource-policy/index.ts", "line": 51 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/resource-policy/index:CfnResourcePolicyProps" }, "awscdk-resources-mongodbatlas.CfnSearchDeployment": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::SearchDeployment" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::SearchDeployment`." }, "fqn": "awscdk-resources-mongodbatlas.CfnSearchDeployment", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::SearchDeployment`." }, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 139 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnSearchDeploymentProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 111 }, "name": "CfnSearchDeployment", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 115 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::SearchDeployment.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 126 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::SearchDeployment.StateName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 130 }, "name": "attrStateName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 121 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnSearchDeploymentProps" } } ], "symbolId": "src/l1-resources/search-deployment/index:CfnSearchDeployment" }, "awscdk-resources-mongodbatlas.CfnSearchDeploymentProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnSearchDeploymentProps" }, "remarks": "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.", "stability": "stable", "summary": "The resource lets you create, edit and delete dedicated search nodes in a cluster." }, "fqn": "awscdk-resources-mongodbatlas.CfnSearchDeploymentProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 10 }, "name": "CfnSearchDeploymentProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnSearchDeploymentProps#ClusterName" }, "stability": "stable", "summary": "Label that identifies the cluster to return the search nodes for." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 23 }, "name": "clusterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchDeploymentProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 30 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchDeploymentProps#Specs" }, "remarks": "This list is currently limited to defining a single element.", "stability": "stable", "summary": "List of settings that configure the search nodes for your cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 37 }, "name": "specs", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiSearchDeploymentSpec" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchDeploymentProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-deployment/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/search-deployment/index:CfnSearchDeploymentProps" }, "awscdk-resources-mongodbatlas.CfnSearchIndex": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::SearchIndex" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::SearchIndex`." }, "fqn": "awscdk-resources-mongodbatlas.CfnSearchIndex", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::SearchIndex`." }, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 444 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnSearchIndexProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 417 }, "name": "CfnSearchIndex", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 421 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::SearchIndex.IndexId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 431 }, "name": "attrIndexId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::SearchIndex.Status`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 435 }, "name": "attrStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 426 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnSearchIndexProps" } } ], "symbolId": "src/l1-resources/search-index/index:CfnSearchIndex" }, "awscdk-resources-mongodbatlas.CfnSearchIndexProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnSearchIndexProps" }, "remarks": "Also returns and updates user-defined analyzers.", "stability": "stable", "summary": "Returns, adds, edits, and removes Atlas Search indexes." }, "fqn": "awscdk-resources-mongodbatlas.CfnSearchIndexProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 10 }, "name": "CfnSearchIndexProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#ClusterName" }, "stability": "stable", "summary": "Name of the cluster that contains the database and collection with one or more Application Search indexes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 46 }, "name": "clusterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#CollectionName" }, "stability": "stable", "summary": "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 53 }, "name": "collectionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Database" }, "stability": "stable", "summary": "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 60 }, "name": "database", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Analyzer" }, "remarks": "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:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\nMongoDB Cloud uses the selected process to build the Atlas Search index.", "stability": "stable", "summary": "Specific pre-defined method chosen to convert database field text into searchable words." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 25 }, "name": "analyzer", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Analyzers" }, "stability": "stable", "summary": "List of user-defined methods to convert database field text into searchable words." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 32 }, "name": "analyzers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsAnalyzersViewManual" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Fields" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 109 }, "name": "fields", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Mappings" }, "stability": "stable", "summary": "Index specifications for the collection's fields." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 74 }, "name": "mappings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsMappingsViewManual" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Name" }, "remarks": "Within each namespace, names of all indexes in the namespace must be unique.", "stability": "stable", "summary": "Human-readable label that identifies this index." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 81 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 39 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 67 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#SearchAnalyzer" }, "stability": "stable", "summary": "Method applied to identify words when searching this index." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 95 }, "name": "searchAnalyzer", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Synonyms" }, "stability": "stable", "summary": "Rule sets that map words to their synonyms in this index." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 102 }, "name": "synonyms", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ApiAtlasFtsSynonymMappingDefinitionView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnSearchIndexProps#Type" }, "remarks": "Default type is **search**.", "stability": "stable", "summary": "Type of index: **search** or **vectorSearch**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 88 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/search-index/index:CfnSearchIndexProps" }, "awscdk-resources-mongodbatlas.CfnServerlessInstance": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ServerlessInstance" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ServerlessInstance`." }, "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstance", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ServerlessInstance`." }, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 371 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstanceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 331 }, "name": "CfnServerlessInstance", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 335 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessInstance.CreateDate`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 346 }, "name": "attrCreateDate", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessInstance.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 350 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessInstance.MongoDBVersion`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 362 }, "name": "attrMongoDBVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessInstance.StateName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 358 }, "name": "attrStateName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessInstance.TotalCount`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 354 }, "name": "attrTotalCount", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 341 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstanceProps" } } ], "symbolId": "src/l1-resources/serverless-instance/index:CfnServerlessInstance" }, "awscdk-resources-mongodbatlas.CfnServerlessInstanceProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps" }, "remarks": "For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/). Returns, adds, edits, and removes serverless instances.", "stability": "stable", "summary": "**WARNING:** This resource is deprecated and will be removed in January 2026." }, "fqn": "awscdk-resources-mongodbatlas.CfnServerlessInstanceProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 10 }, "name": "CfnServerlessInstanceProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#ConnectionStrings" }, "stability": "stable", "summary": "Collection of Uniform Resource Locators that point to the MongoDB database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 16 }, "name": "connectionStrings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceConnectionStrings" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#ContinuousBackupEnabled" }, "remarks": "If this parameter is false, the serverless instance uses Basic Backup. | Option | Description | |---|---| | Serverless Continuous Backup | Atlas takes incremental snapshots of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see Serverless Instance Costs. | | Basic Backup | Atlas takes incremental snapshots of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free.", "stability": "stable", "summary": "Flag that indicates whether the serverless instances uses Serverless Continuous Backup." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 23 }, "name": "continuousBackupEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#IncludeCount" }, "stability": "stable", "summary": "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 30 }, "name": "includeCount", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#ItemsPerPage" }, "stability": "stable", "summary": "Number of items that the response returns per page." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 37 }, "name": "itemsPerPage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the serverless instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 44 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 51 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 79 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#ProjectID" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 58 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#ProviderSettings" }, "remarks": "The options available relate to the cloud service provider.", "stability": "stable", "summary": "Group of settings that configure the provisioned MongoDB serverless instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 65 }, "name": "providerSettings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettings" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessInstanceProps#TerminationProtectionEnabled" }, "remarks": "If set to true, MongoDB Cloud won't delete the serverless instance. If set to false, MongoDB cloud will delete the serverless instance.\"", "stability": "stable", "summary": "Flag that indicates whether termination protection is enabled on the serverless instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 72 }, "name": "terminationProtectionEnabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/serverless-instance/index:CfnServerlessInstanceProps" }, "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ServerlessPrivateEndpoint" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ServerlessPrivateEndpoint`." }, "fqn": "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpoint", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ServerlessPrivateEndpoint`." }, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 215 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpointProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 171 }, "name": "CfnServerlessPrivateEndpoint", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 175 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 206 }, "name": "attrAwsPrivateEndpointMetaData", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 190 }, "name": "attrEndpointServiceName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 194 }, "name": "attrErrorMessage", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 186 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 198 }, "name": "attrProviderName", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Status`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 202 }, "name": "attrStatus", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 181 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpointProps" } } ], "symbolId": "src/l1-resources/serverless-private-endpoint/index:CfnServerlessPrivateEndpoint" }, "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpointProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps" }, "remarks": "If you try to create a new ServerlessInstance, you will create a Flex cluster. As a result, you can't create ServerlessPrivateEndpoints for these new instances. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/). Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", "stability": "stable", "summary": "**WARNING:** This resource is deprecated and will be removed in May 2025." }, "fqn": "awscdk-resources-mongodbatlas.CfnServerlessPrivateEndpointProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 10 }, "name": "CfnServerlessPrivateEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#InstanceName" }, "stability": "stable", "summary": "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 23 }, "name": "instanceName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 16 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#AwsPrivateEndpointConfigurationProperties" }, "stability": "stable", "summary": "Properties used to configure Aws private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 65 }, "name": "awsPrivateEndpointConfigurationProperties", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AwsPrivateEndpointConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#CloudProviderEndpointId" }, "stability": "stable", "summary": "Unique string that identifies the private endpoint's network interface." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 44 }, "name": "cloudProviderEndpointId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#Comment" }, "stability": "stable", "summary": "Human-readable comment associated with the private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 30 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#CreateAndAssignAWSPrivateEndpoint" }, "stability": "stable", "summary": "If true the resource will create the aws private endpoint and assign the Endpoint ID." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 58 }, "name": "createAndAssignAwsPrivateEndpoint", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#PrivateEndpointIpAddress" }, "stability": "stable", "summary": "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 51 }, "name": "privateEndpointIpAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnServerlessPrivateEndpointProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-private-endpoint/index.ts", "line": 37 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/serverless-private-endpoint/index:CfnServerlessPrivateEndpointProps" }, "awscdk-resources-mongodbatlas.CfnStreamConnection": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::StreamConnection" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::StreamConnection`." }, "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnection", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::StreamConnection`." }, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 302 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnectionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 283 }, "name": "CfnStreamConnection", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 287 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 293 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnectionProps" } } ], "symbolId": "src/l1-resources/stream-connection/index:CfnStreamConnection" }, "awscdk-resources-mongodbatlas.CfnStreamConnectionProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps" }, "remarks": "To use this resource, the requesting API Key must have the Project Owner roles.", "stability": "stable", "summary": "Returns, adds, edits, and removes one connection for a stream instance in the specified project." }, "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnectionProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 10 }, "name": "CfnStreamConnectionProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#ConnectionName" }, "remarks": "In the case of the Sample type, this is the name of the sample source.", "stability": "stable", "summary": "Human-readable label that identifies the stream connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 32 }, "name": "connectionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#InstanceName" }, "stability": "stable", "summary": "Human-readable label that identifies the stream instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 39 }, "name": "instanceName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#ProjectId" }, "remarks": "Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 18 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#Type" }, "remarks": "Can be either Cluster, Kafka, or Sample.", "stability": "stable", "summary": "Type of the connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 46 }, "name": "type", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnectionPropsType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#Authentication" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 63 }, "name": "authentication", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaAuthentication" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#BootstrapServers" }, "stability": "stable", "summary": "Comma separated list of server addresses." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 70 }, "name": "bootstrapServers", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#ClusterName" }, "stability": "stable", "summary": "Name of the cluster configured for this connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 53 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#Config" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 80 }, "name": "config", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#DbRoleToExecute" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 58 }, "name": "dbRoleToExecute", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DbRoleToExecute" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 25 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamConnectionProps#Security" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 75 }, "name": "security", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaSecurity" } } ], "symbolId": "src/l1-resources/stream-connection/index:CfnStreamConnectionProps" }, "awscdk-resources-mongodbatlas.CfnStreamConnectionPropsType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnStreamConnectionPropsType" }, "remarks": "Can be either Cluster, Kafka, or Sample.", "stability": "stable", "summary": "Type of the connection." }, "fqn": "awscdk-resources-mongodbatlas.CfnStreamConnectionPropsType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 119 }, "members": [ { "docs": { "stability": "stable", "summary": "Kafka." }, "name": "KAFKA" }, { "docs": { "stability": "stable", "summary": "Cluster." }, "name": "CLUSTER" }, { "docs": { "stability": "stable", "summary": "Sample." }, "name": "SAMPLE" } ], "name": "CfnStreamConnectionPropsType", "symbolId": "src/l1-resources/stream-connection/index:CfnStreamConnectionPropsType" }, "awscdk-resources-mongodbatlas.CfnStreamInstance": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::StreamInstance" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::StreamInstance`." }, "fqn": "awscdk-resources-mongodbatlas.CfnStreamInstance", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::StreamInstance`." }, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 434 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnStreamInstanceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 406 }, "name": "CfnStreamInstance", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 410 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::StreamInstance.Hostnames`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 425 }, "name": "attrHostnames", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::StreamInstance.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 421 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 416 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnStreamInstanceProps" } } ], "symbolId": "src/l1-resources/stream-instance/index:CfnStreamInstance" }, "awscdk-resources-mongodbatlas.CfnStreamInstanceProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps" }, "stability": "stable", "summary": "Returns, adds, edits, and removes Atlas Stream Processing Instances." }, "fqn": "awscdk-resources-mongodbatlas.CfnStreamInstanceProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 10 }, "name": "CfnStreamInstanceProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#DataProcessRegion" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 28 }, "name": "dataProcessRegion", "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsDataProcessRegion" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#InstanceName" }, "stability": "stable", "summary": "Human-readable label that identifies the stream connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 23 }, "name": "instanceName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 45 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#StreamConfig" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 33 }, "name": "streamConfig", "type": { "fqn": "awscdk-resources-mongodbatlas.StreamConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#Connections" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 38 }, "name": "connections", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.StreamsConnection" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnStreamInstanceProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/stream-instance/index:CfnStreamInstanceProps" }, "awscdk-resources-mongodbatlas.CfnTeams": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Teams" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Teams`." }, "fqn": "awscdk-resources-mongodbatlas.CfnTeams", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Teams`." }, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 404 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnTeamsProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 381 }, "name": "CfnTeams", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 385 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Teams.TeamId`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 395 }, "name": "attrTeamId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 390 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnTeamsProps" } } ], "symbolId": "src/l1-resources/teams/index:CfnTeams" }, "awscdk-resources-mongodbatlas.CfnTeamsProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnTeamsProps" }, "remarks": "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.", "stability": "stable", "summary": "Adds one team to the specified project." }, "fqn": "awscdk-resources-mongodbatlas.CfnTeamsProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 10 }, "name": "CfnTeamsProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 44 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#OrgId" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 30 }, "name": "orgId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 37 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#RoleNames" }, "stability": "stable", "summary": "One or more organization- or project-level roles to assign to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 23 }, "name": "roleNames", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnTeamsPropsRoleNames" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#Usernames" }, "stability": "stable", "summary": "List that contains the MongoDB Cloud users in this team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 51 }, "name": "usernames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTeamsProps#Users" }, "stability": "stable", "summary": "List of returned documents that MongoDB Cloud provides when completing this request." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 58 }, "name": "users", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AtlasUser" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/teams/index:CfnTeamsProps" }, "awscdk-resources-mongodbatlas.CfnTeamsPropsRoleNames": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnTeamsPropsRoleNames" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CfnTeamsPropsRoleNames", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/teams/index.ts", "line": 91 }, "members": [ { "docs": { "stability": "stable", "summary": "GROUP_CLUSTER_MANAGER." }, "name": "GROUP_CLUSTER_MANAGER" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_ADMIN." }, "name": "GROUP_DATA_ACCESS_ADMIN" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_ONLY." }, "name": "GROUP_DATA_ACCESS_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_WRITE." }, "name": "GROUP_DATA_ACCESS_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "GROUP_OWNER." }, "name": "GROUP_OWNER" }, { "docs": { "stability": "stable", "summary": "GROUP_READ_ONLY." }, "name": "GROUP_READ_ONLY" } ], "name": "CfnTeamsPropsRoleNames", "symbolId": "src/l1-resources/teams/index:CfnTeamsPropsRoleNames" }, "awscdk-resources-mongodbatlas.CfnThirdPartyIntegration": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::ThirdPartyIntegration" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::ThirdPartyIntegration`." }, "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegration", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::ThirdPartyIntegration`." }, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 265 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 246 }, "name": "CfnThirdPartyIntegration", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 250 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 256 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationProps" } } ], "symbolId": "src/l1-resources/third-party-integration/index:CfnThirdPartyIntegration" }, "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps" }, "remarks": "MongoDB Cloud sends alerts to each third-party service that you configure.", "stability": "stable", "summary": "Returns, adds, edits, and removes third-party service integration configurations." }, "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 10 }, "name": "CfnThirdPartyIntegrationProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ApiKey" }, "stability": "stable", "summary": "Key that allows MongoDB Cloud to access your Opsgenie/Datadog account." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 37 }, "name": "apiKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ApiToken" }, "stability": "stable", "summary": "Key that allows MongoDB Cloud to access your Slack account." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 58 }, "name": "apiToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ChannelName" }, "stability": "stable", "summary": "Name of the Slack channel to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 72 }, "name": "channelName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Enabled" }, "stability": "stable", "summary": "Flag that indicates whether someone has activated the Prometheus integration." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 135 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ListenAddress" }, "stability": "stable", "summary": "Combination of IPv4 address and Internet Assigned Numbers Authority (IANA) port or the IANA port alone to which Prometheus binds to ingest MongoDB metrics." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 142 }, "name": "listenAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#MicrosoftTeamsWebhookUrl" }, "stability": "stable", "summary": "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 100 }, "name": "microsoftTeamsWebhookUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Password" }, "stability": "stable", "summary": "Password required for your integration with Prometheus." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 114 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 23 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 16 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Region" }, "stability": "stable", "summary": "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie/Datadog API." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 44 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#RoutingKey" }, "stability": "stable", "summary": "Routing key associated with your Splunk On-Call account." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 79 }, "name": "routingKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Scheme" }, "stability": "stable", "summary": "Security Scheme to apply to HyperText Transfer Protocol (HTTP) traffic between Prometheus and MongoDB Cloud." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 128 }, "name": "scheme", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsScheme" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Secret" }, "stability": "stable", "summary": "Parameter returned if someone configure this webhook with a secret." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 93 }, "name": "secret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ServiceDiscovery" }, "stability": "stable", "summary": "Desired method to discover the Prometheus service." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 121 }, "name": "serviceDiscovery", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsServiceDiscovery" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#ServiceKey" }, "stability": "stable", "summary": "Service key associated with your PagerDuty account." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 51 }, "name": "serviceKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#TeamName" }, "remarks": "Set this parameter when you configure a legacy Slack integration.", "stability": "stable", "summary": "Human-readable label that identifies your Slack team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 65 }, "name": "teamName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#TlsPemPath" }, "stability": "stable", "summary": "Root-relative path to the Transport Layer Security (TLS) Privacy Enhanced Mail (PEM) key and certificate file on the host." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 149 }, "name": "tlsPemPath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Type" }, "remarks": "The value must match the third-party service integration type.", "stability": "stable", "summary": "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 30 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsType" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#Url" }, "stability": "stable", "summary": "Endpoint web address to which MongoDB Cloud sends notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 86 }, "name": "url", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnThirdPartyIntegrationProps#UserName" }, "stability": "stable", "summary": "Human-readable label that identifies your Prometheus incoming webhook." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 107 }, "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/third-party-integration/index:CfnThirdPartyIntegrationProps" }, "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsScheme": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnThirdPartyIntegrationPropsScheme" }, "stability": "stable", "summary": "Security Scheme to apply to HyperText Transfer Protocol (HTTP) traffic between Prometheus and MongoDB Cloud." }, "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsScheme", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 233 }, "members": [ { "docs": { "stability": "stable", "summary": "http." }, "name": "HTTP" }, { "docs": { "stability": "stable", "summary": "https." }, "name": "HTTPS" } ], "name": "CfnThirdPartyIntegrationPropsScheme", "symbolId": "src/l1-resources/third-party-integration/index:CfnThirdPartyIntegrationPropsScheme" }, "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsServiceDiscovery": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnThirdPartyIntegrationPropsServiceDiscovery" }, "stability": "stable", "summary": "Desired method to discover the Prometheus service." }, "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsServiceDiscovery", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 221 }, "members": [ { "docs": { "stability": "stable", "summary": "http." }, "name": "HTTP" }, { "docs": { "stability": "stable", "summary": "file." }, "name": "FILE" } ], "name": "CfnThirdPartyIntegrationPropsServiceDiscovery", "symbolId": "src/l1-resources/third-party-integration/index:CfnThirdPartyIntegrationPropsServiceDiscovery" }, "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CfnThirdPartyIntegrationPropsType" }, "remarks": "The value must match the third-party service integration type.", "stability": "stable", "summary": "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud." }, "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegrationPropsType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/third-party-integration/index.ts", "line": 197 }, "members": [ { "docs": { "stability": "stable", "summary": "PAGER_DUTY." }, "name": "PAGER_DUTY" }, { "docs": { "stability": "stable", "summary": "MICROSOFT_TEAMS." }, "name": "MICROSOFT_TEAMS" }, { "docs": { "stability": "stable", "summary": "SLACK." }, "name": "SLACK" }, { "docs": { "stability": "stable", "summary": "DATADOG." }, "name": "DATADOG" }, { "docs": { "stability": "stable", "summary": "OPS_GENIE." }, "name": "OPS_GENIE" }, { "docs": { "stability": "stable", "summary": "VICTOR_OPS." }, "name": "VICTOR_OPS" }, { "docs": { "stability": "stable", "summary": "WEBHOOK." }, "name": "WEBHOOK" }, { "docs": { "stability": "stable", "summary": "PROMETHEUS." }, "name": "PROMETHEUS" } ], "name": "CfnThirdPartyIntegrationPropsType", "symbolId": "src/l1-resources/third-party-integration/index:CfnThirdPartyIntegrationPropsType" }, "awscdk-resources-mongodbatlas.CfnTrigger": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::Trigger" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::Trigger`." }, "fqn": "awscdk-resources-mongodbatlas.CfnTrigger", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::Trigger`." }, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 648 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnTriggerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 625 }, "name": "CfnTrigger", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 629 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::Trigger.Id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 639 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 634 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnTriggerProps" } } ], "symbolId": "src/l1-resources/trigger/index:CfnTrigger" }, "awscdk-resources-mongodbatlas.CfnTriggerProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnTriggerProps" }, "stability": "stable", "summary": "View and manage your application's triggers: https://www.mongodb.com/docs/atlas/app-services/triggers/." }, "fqn": "awscdk-resources-mongodbatlas.CfnTriggerProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 10 }, "name": "CfnTriggerProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#AppId" }, "stability": "stable", "summary": "App Services Application ID." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 97 }, "name": "appId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#Name" }, "stability": "stable", "summary": "The trigger's name." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 38 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#ProjectId" }, "stability": "stable", "summary": "Project Id for application services." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 104 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#Type" }, "stability": "stable", "summary": "The trigger's type." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 45 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#AuthTrigger" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 26 }, "name": "authTrigger", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.AuthConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#DatabaseTrigger" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 21 }, "name": "databaseTrigger", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DatabaseConfig" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#Disabled" }, "stability": "stable", "summary": "If `true`, the trigger is disabled and does not listen for events or execute." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 52 }, "name": "disabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#EventProcessors" }, "remarks": "For an example configuration object, see\n[Send Trigger Events to AWS\nEventBridge](https://www.mongodb.com/docs/atlas/app-services/triggers/aws-eventbridge/#std-label-event_processor_example).", "stability": "stable", "summary": "An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 90 }, "name": "eventProcessors", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.Event" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#FunctionId" }, "remarks": "This value is the same as `event_processors.FUNCTION.function_id`.\nYou can either define the value here or in `event_processors.FUNCTION.function_id`.\nThe App Services backend duplicates the value to the configuration location where you did not define it.\n\nFor example, if you define `function_id`, the backend duplicates it to `event_processors.FUNCTION.function_id`.", "stability": "stable", "summary": "The ID of the function that the trigger calls when it fires." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 65 }, "name": "functionId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#FunctionName" }, "remarks": "This value is the same as `event_processors.FUNCTION.function_name`.\nYou can either define the value here or in `event_processors.FUNCTION.function_name`.\nThe App Services backend duplicates the value to the configuration location where you did not define it.\n\nFor example, if you define `function_name`, the backend duplicates it to `event_processors.FUNCTION.function_name`.", "stability": "stable", "summary": "The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 79 }, "name": "functionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#Profile" }, "remarks": "See [Secret Manager Profile setup](../../../examples/profile-secret.yaml).", "stability": "stable", "summary": "The profile is defined in AWS Secret manager." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 16 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnTriggerProps#ScheduleTrigger" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 31 }, "name": "scheduleTrigger", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ScheduleConfig" } } ], "symbolId": "src/l1-resources/trigger/index:CfnTriggerProps" }, "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUser": { "assembly": "awscdk-resources-mongodbatlas", "base": "aws-cdk-lib.CfnResource", "docs": { "custom": { "cloudformationResource": "MongoDB::Atlas::X509AuthenticationDatabaseUser" }, "stability": "external", "summary": "A CloudFormation `MongoDB::Atlas::X509AuthenticationDatabaseUser`." }, "fqn": "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUser", "initializer": { "docs": { "stability": "external", "summary": "Create a new `MongoDB::Atlas::X509AuthenticationDatabaseUser`." }, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 135 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUserProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 107 }, "name": "CfnX509AuthenticationDatabaseUser", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 111 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 126 }, "name": "attrMonthsUntilExpiration", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 122 }, "name": "attrTotalCount", "type": { "primitive": "number" } }, { "docs": { "stability": "external", "summary": "Resource props." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 117 }, "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUserProps" } } ], "symbolId": "src/l1-resources/x509-authentication-database-user/index:CfnX509AuthenticationDatabaseUser" }, "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUserProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CfnX509AuthenticationDatabaseUserProps" }, "remarks": "To get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf 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.", "stability": "stable", "summary": "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." }, "fqn": "awscdk-resources-mongodbatlas.CfnX509AuthenticationDatabaseUserProps", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 14 }, "name": "CfnX509AuthenticationDatabaseUserProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CfnX509AuthenticationDatabaseUserProps#CustomerX509" }, "stability": "stable", "summary": "CustomerX509 represents Customer-managed X.509 configuration for an Atlas project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 27 }, "name": "customerX509", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CustomerX509" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnX509AuthenticationDatabaseUserProps#Profile" }, "stability": "stable", "summary": "Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 20 }, "name": "profile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnX509AuthenticationDatabaseUserProps#ProjectId" }, "stability": "stable", "summary": "The unique identifier for the project ." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 41 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CfnX509AuthenticationDatabaseUserProps#UserName" }, "stability": "stable", "summary": "Username of the database user to create a certificate for." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 34 }, "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/x509-authentication-database-user/index:CfnX509AuthenticationDatabaseUserProps" }, "awscdk-resources-mongodbatlas.CloudProviderConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CloudProviderConfig" }, "stability": "stable", "summary": "Cloud provider linked to this data lake.." }, "fqn": "awscdk-resources-mongodbatlas.CloudProviderConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 93 }, "name": "CloudProviderConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CloudProviderConfig#ExternalId" }, "stability": "stable", "summary": "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 99 }, "name": "externalId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CloudProviderConfig#IamAssumedRoleARN" }, "stability": "stable", "summary": "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 106 }, "name": "iamAssumedRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CloudProviderConfig#IamUserARN" }, "stability": "stable", "summary": "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 113 }, "name": "iamUserArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CloudProviderConfig#RoleId" }, "stability": "stable", "summary": "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 120 }, "name": "roleId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CloudProviderConfig#TestS3Bucket" }, "stability": "stable", "summary": "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 127 }, "name": "testS3Bucket", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:CloudProviderConfig" }, "awscdk-resources-mongodbatlas.ClusterProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "ClusterProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ClusterProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 140 }, "name": "ClusterProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "Advanced configuration details to add for one cluster in the specified project.", "memberof": "ClusterProps", "type": "{atlas.ProcessArgs}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 146 }, "name": "advancedSettings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ProcessArgs" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{boolean}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 152 }, "name": "backupEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "description": "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", "memberof": "ClusterProps", "type": "{atlas.CfnClusterPropsBiConnector}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 158 }, "name": "biConnector", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsBiConnector" } }, { "abstract": true, "docs": { "custom": { "description": "Configuration of nodes that comprise the cluster. Atlas accepts: `REPLICASET`, `SHARDED`, `GEOSHARDED`.", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 164 }, "name": "clusterType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{atlas.ConnectionStrings}" }, "default": "REPLICASET", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 171 }, "name": "connectionStrings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ConnectionStrings" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{number}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 177 }, "name": "diskSizeGb", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{atlas.CfnClusterPropsEncryptionAtRestProvider}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 183 }, "name": "encryptionAtRestProvider", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsEncryptionAtRestProvider" } }, { "abstract": true, "docs": { "custom": { "description": "Collection of key-value pairs between 1 and 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.", "memberof": "ClusterProps", "type": "{atlas.CfnClusterPropsLabels[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 195 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.CfnClusterPropsLabels" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 201 }, "name": "mongoDbMajorVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "Human-readable label that identifies the advanced cluster.", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 207 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "Flag that indicates whether the cluster is paused or not.", "memberof": "ClusterProps", "type": "{boolean}" }, "default": "auto-generated", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 214 }, "name": "paused", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "description": "Flag that indicates whether the cluster uses continuous cloud backups.", "memberof": "ClusterProps", "type": "{boolean}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 220 }, "name": "pitEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 189 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{atlas.AdvancedReplicationSpec[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 226 }, "name": "replicationSpecs", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AdvancedReplicationSpec" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 232 }, "name": "rootCertType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "ClusterProps", "type": "{boolean}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 244 }, "name": "terminationProtectionEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "description": "Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion", "memberof": "ClusterProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 238 }, "name": "versionReleaseSystem", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/common/props:ClusterProps" }, "awscdk-resources-mongodbatlas.Collection": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Collection" }, "stability": "stable", "summary": "Array of collections and data sources that map to a stores data store." }, "fqn": "awscdk-resources-mongodbatlas.Collection", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 370 }, "name": "Collection", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Collection#DataSources" }, "stability": "stable", "summary": "Array that contains the data stores that map to a collection for this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 376 }, "name": "dataSources", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DataSource" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "Collection#Name" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 381 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:Collection" }, "awscdk-resources-mongodbatlas.Compute": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "compute" }, "stability": "stable", "summary": "Automatic Compute Scaling." }, "fqn": "awscdk-resources-mongodbatlas.Compute", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 842 }, "name": "Compute", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "compute#Enabled" }, "remarks": "Set to true to enable instance size auto-scaling. If enabled, you must specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.\nSet to false to disable instance size automatic scaling.", "stability": "stable", "summary": "Flag that indicates whether someone enabled instance size auto-scaling." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 851 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "compute#MaxInstanceSize" }, "remarks": "MongoDB Cloud requires this parameter if \"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true.", "stability": "stable", "summary": "Maximum instance size to which your cluster can automatically scale." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 872 }, "name": "maxInstanceSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "compute#MinInstanceSize" }, "remarks": "MongoDB Cloud requires this parameter if \"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true.", "stability": "stable", "summary": "Minimum instance size to which your cluster can automatically scale." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 865 }, "name": "minInstanceSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "compute#ScaleDownEnabled" }, "remarks": "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.", "stability": "stable", "summary": "Flag that indicates whether the instance size may scale down." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 858 }, "name": "scaleDownEnabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/cluster/index:Compute" }, "awscdk-resources-mongodbatlas.ConnectionStrings": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "connectionStrings" }, "stability": "stable", "summary": "Collection of Uniform Resource Locators that point to the MongoDB database." }, "fqn": "awscdk-resources-mongodbatlas.ConnectionStrings", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 356 }, "name": "ConnectionStrings", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#Private" }, "remarks": "This connection string uses the mongodb+srv:// protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", "stability": "stable", "summary": "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 376 }, "name": "private", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#PrivateEndpoints" }, "remarks": "Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", "stability": "stable", "summary": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 390 }, "name": "privateEndpoints", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#PrivateEndpointsSrv" }, "remarks": "Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to Atlas through the interface endpoint that the key names.", "stability": "stable", "summary": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 397 }, "name": "privateEndpointsSrv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#PrivateSrv" }, "remarks": "This connection string uses the mongodb+srv:// protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this parameter returns only if you enable custom DNS.", "stability": "stable", "summary": "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 383 }, "name": "privateSrv", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#SRVShardOptimizedConnectionString" }, "remarks": "If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", "stability": "stable", "summary": "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 404 }, "name": "srvShardOptimizedConnectionString", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#Standard" }, "remarks": "This connection string uses the mongodb:// protocol.", "stability": "stable", "summary": "Public connection string that you can use to connect to this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 362 }, "name": "standard", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "connectionStrings#StandardSrv" }, "remarks": "This connection string uses the mongodb+srv:// protocol.", "stability": "stable", "summary": "Public connection string that you can use to connect to this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 369 }, "name": "standardSrv", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:ConnectionStrings" }, "awscdk-resources-mongodbatlas.CriteriaView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "CriteriaView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CriteriaView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 153 }, "name": "CriteriaView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "CriteriaView#DateField" }, "remarks": "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\".", "stability": "stable", "summary": "Indexed database parameter that stores the date that determines when data moves to the online archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 166 }, "name": "dateField", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CriteriaView#DateFormat" }, "remarks": "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\".", "stability": "stable", "summary": "Syntax used to write the date after which data moves to the online archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 173 }, "name": "dateFormat", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CriteriaViewDateFormat" } }, { "abstract": true, "docs": { "custom": { "schema": "CriteriaView#ExpireAfterDays" }, "stability": "stable", "summary": "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\"." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 180 }, "name": "expireAfterDays", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "CriteriaView#Query" }, "remarks": "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\".", "stability": "stable", "summary": "MongoDB find query that selects documents to archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 187 }, "name": "query", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "CriteriaView#Type" }, "remarks": "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`.", "stability": "stable", "summary": "Means by which MongoDB Cloud selects data to archive." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 159 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CriteriaViewType" } } ], "symbolId": "src/l1-resources/online-archive/index:CriteriaView" }, "awscdk-resources-mongodbatlas.CriteriaViewDateFormat": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CriteriaViewDateFormat" }, "remarks": "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\".", "stability": "stable", "summary": "Syntax used to write the date after which data moves to the online archive." }, "fqn": "awscdk-resources-mongodbatlas.CriteriaViewDateFormat", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 352 }, "members": [ { "docs": { "stability": "stable", "summary": "ISODATE." }, "name": "ISODATE" }, { "docs": { "stability": "stable", "summary": "EPOCH_SECONDS." }, "name": "EPOCH_SECONDS" }, { "docs": { "stability": "stable", "summary": "EPOCH_MILLIS." }, "name": "EPOCH_MILLIS" }, { "docs": { "stability": "stable", "summary": "EPOCH_NANOSECONDS." }, "name": "EPOCH_NANOSECONDS" } ], "name": "CriteriaViewDateFormat", "symbolId": "src/l1-resources/online-archive/index:CriteriaViewDateFormat" }, "awscdk-resources-mongodbatlas.CriteriaViewType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "CriteriaViewType" }, "remarks": "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`.", "stability": "stable", "summary": "Means by which MongoDB Cloud selects data to archive." }, "fqn": "awscdk-resources-mongodbatlas.CriteriaViewType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 340 }, "members": [ { "docs": { "stability": "stable", "summary": "DATE." }, "name": "DATE" }, { "docs": { "stability": "stable", "summary": "CUSTOM." }, "name": "CUSTOM" } ], "name": "CriteriaViewType", "symbolId": "src/l1-resources/online-archive/index:CriteriaViewType" }, "awscdk-resources-mongodbatlas.CustomerX509": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "customerX509" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.CustomerX509", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 71 }, "name": "CustomerX509", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "customerX509#Cas" }, "stability": "stable", "summary": "PEM string containing one or more customer CAs for database user authentication." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/x509-authentication-database-user/index.ts", "line": 77 }, "name": "cas", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/x509-authentication-database-user/index:CustomerX509" }, "awscdk-resources-mongodbatlas.DataLakeAwsCloudProviderConfigView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeAwsCloudProviderConfigView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 218 }, "name": "DataLakeAwsCloudProviderConfigView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView#ExternalId" }, "stability": "stable", "summary": "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 224 }, "name": "externalId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView#IamAssumedRoleARN" }, "stability": "stable", "summary": "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 231 }, "name": "iamAssumedRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView#IamUserARN" }, "stability": "stable", "summary": "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 238 }, "name": "iamUserArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView#RoleId" }, "stability": "stable", "summary": "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 245 }, "name": "roleId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeAWSCloudProviderConfigView#TestS3Bucket" }, "stability": "stable", "summary": "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 252 }, "name": "testS3Bucket", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeAwsCloudProviderConfigView" }, "awscdk-resources-mongodbatlas.DataLakeCloudProviderConfigView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeCloudProviderConfigView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeCloudProviderConfigView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 103 }, "name": "DataLakeCloudProviderConfigView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeCloudProviderConfigView#Aws" }, "stability": "stable", "summary": "Name of the cloud service that hosts the data lake's data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 109 }, "name": "aws", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeAwsCloudProviderConfigView" } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeCloudProviderConfigView" }, "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeDataProcessRegionView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 136 }, "name": "DataLakeDataProcessRegionView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeDataProcessRegionView#CloudProvider" }, "stability": "stable", "summary": "Name of the cloud service that hosts the data lake's data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 142 }, "name": "cloudProvider", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewCloudProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDataProcessRegionView#Region" }, "stability": "stable", "summary": "Name of the region to which the data lake routes client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 149 }, "name": "region", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewRegion" } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeDataProcessRegionView" }, "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewCloudProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "DataLakeDataProcessRegionViewCloudProvider" }, "stability": "stable", "summary": "Name of the cloud service that hosts the data lake's data stores." }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewCloudProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 285 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "TENANT." }, "name": "TENANT" }, { "docs": { "stability": "stable", "summary": "SERVERLESS." }, "name": "SERVERLESS" } ], "name": "DataLakeDataProcessRegionViewCloudProvider", "symbolId": "src/l1-resources/datalakes/index:DataLakeDataProcessRegionViewCloudProvider" }, "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewRegion": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "DataLakeDataProcessRegionViewRegion" }, "stability": "stable", "summary": "Name of the region to which the data lake routes client connections." }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDataProcessRegionViewRegion", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 303 }, "members": [ { "docs": { "stability": "stable", "summary": "DUBLIN_IRL." }, "name": "DUBLIN_IRL" }, { "docs": { "stability": "stable", "summary": "FRANKFURT_DEU." }, "name": "FRANKFURT_DEU" }, { "docs": { "stability": "stable", "summary": "LONDON_GBR." }, "name": "LONDON_GBR" }, { "docs": { "stability": "stable", "summary": "MUMBAI_IND." }, "name": "MUMBAI_IND" }, { "docs": { "stability": "stable", "summary": "OREGON_USA." }, "name": "OREGON_USA" }, { "docs": { "stability": "stable", "summary": "SYDNEY_AUS." }, "name": "SYDNEY_AUS" }, { "docs": { "stability": "stable", "summary": "VIRGINIA_USA." }, "name": "VIRGINIA_USA" } ], "name": "DataLakeDataProcessRegionViewRegion", "symbolId": "src/l1-resources/datalakes/index:DataLakeDataProcessRegionViewRegion" }, "awscdk-resources-mongodbatlas.DataLakeDatabaseCollectionView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeDatabaseCollectionView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseCollectionView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 473 }, "name": "DataLakeDatabaseCollectionView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseCollectionView#DataSources" }, "stability": "stable", "summary": "Array that contains the data stores that map to a collection for this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 479 }, "name": "dataSources", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseCollectionView#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 486 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeDatabaseCollectionView" }, "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 565 }, "name": "DataLakeDatabaseDataSourceView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#AllowInsecure" }, "remarks": "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.", "stability": "stable", "summary": "Flag that validates the scheme in the specified URLs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 571 }, "name": "allowInsecure", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#Collection" }, "remarks": "For creating a wildcard (`*`) collection, you must omit this parameter.", "stability": "stable", "summary": "Human-readable label that identifies the collection in the database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 578 }, "name": "collection", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#CollectionRegex" }, "remarks": "To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp).", "stability": "stable", "summary": "Regex pattern to use for creating the wildcard (*) collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 585 }, "name": "collectionRegex", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#Database" }, "remarks": "You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases.", "stability": "stable", "summary": "Human-readable label that identifies the database, which contains the collection in the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 592 }, "name": "database", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#DefaultFormat" }, "stability": "stable", "summary": "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 599 }, "name": "defaultFormat", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceViewDefaultFormat" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#Path" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 606 }, "name": "path", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#StoreName" }, "stability": "stable", "summary": "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 613 }, "name": "storeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceView#Urls" }, "remarks": "You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", "stability": "stable", "summary": "URLs of the publicly accessible data files." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 620 }, "name": "urls", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeDatabaseDataSourceView" }, "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceViewDefaultFormat": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "DataLakeDatabaseDataSourceViewDefaultFormat" }, "stability": "stable", "summary": "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**." }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseDataSourceViewDefaultFormat", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 656 }, "members": [ { "docs": { "stability": "stable", "summary": ".avro." }, "name": "AVRO" }, { "docs": { "stability": "stable", "summary": ".avro.gz." }, "name": "AVRO_GZ" }, { "docs": { "stability": "stable", "summary": ".bson." }, "name": "BSON" }, { "docs": { "stability": "stable", "summary": ".bson.gz." }, "name": "BSON_GZ" }, { "docs": { "stability": "stable", "summary": ".csv." }, "name": "CSV" }, { "docs": { "stability": "stable", "summary": ".json." }, "name": "JSON" }, { "docs": { "stability": "stable", "summary": ".json.gz." }, "name": "JSON_GZ" }, { "docs": { "stability": "stable", "summary": ".orc." }, "name": "ORC" }, { "docs": { "stability": "stable", "summary": ".tsv." }, "name": "TSV" }, { "docs": { "stability": "stable", "summary": ".tsv.gz." }, "name": "TSV_GZ" } ], "name": "DataLakeDatabaseDataSourceViewDefaultFormat", "symbolId": "src/l1-resources/datalakes/index:DataLakeDatabaseDataSourceViewDefaultFormat" }, "awscdk-resources-mongodbatlas.DataLakeDatabaseView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeDatabaseView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 323 }, "name": "DataLakeDatabaseView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseView#Collections" }, "stability": "stable", "summary": "Array of collections and data sources that map to a ``stores`` data store." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 329 }, "name": "collections", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseCollectionView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseView#MaxWildcardCollections" }, "remarks": "This only applies to S3 data sources.", "stability": "stable", "summary": "Maximum number of wildcard collections in the database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 336 }, "name": "maxWildcardCollections", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseView#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the database to which the data lake maps data." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 343 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeDatabaseView#Views" }, "remarks": "This only applies to S3 data sources.", "stability": "stable", "summary": "Array of aggregation pipelines that apply to the collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 350 }, "name": "views", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DataLakeViewView" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeDatabaseView" }, "awscdk-resources-mongodbatlas.DataLakeStorageView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeStorageView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeStorageView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 177 }, "name": "DataLakeStorageView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeStorageView#Databases" }, "stability": "stable", "summary": "Array that contains the queryable databases and collections for this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 183 }, "name": "databases", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DataLakeDatabaseView" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeStorageView#Stores" }, "stability": "stable", "summary": "Array that contains the data stores for the data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 190 }, "name": "stores", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.StoreDetail" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeStorageView" }, "awscdk-resources-mongodbatlas.DataLakeViewView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataLakeViewView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataLakeViewView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 516 }, "name": "DataLakeViewView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataLakeViewView#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 522 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeViewView#Pipeline" }, "stability": "stable", "summary": "Aggregation pipeline stages to apply to the source collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 529 }, "name": "pipeline", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataLakeViewView#Source" }, "stability": "stable", "summary": "Human-readable label that identifies the source collection for the view." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 536 }, "name": "source", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/datalakes/index:DataLakeViewView" }, "awscdk-resources-mongodbatlas.DataProcessRegion": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataProcessRegion" }, "remarks": "MongoDB Cloud supports AWS only.", "stability": "stable", "summary": "Information about the cloud provider region to which the data lake routes client connections." }, "fqn": "awscdk-resources-mongodbatlas.DataProcessRegion", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 160 }, "name": "DataProcessRegion", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataProcessRegion#Region" }, "stability": "stable", "summary": "Name of the region to which the data lake routes client connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 173 }, "name": "region", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataProcessRegion#CloudProvider" }, "stability": "stable", "summary": "Name of the cloud service that hosts the data lake's data stores." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 166 }, "name": "cloudProvider", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:DataProcessRegion" }, "awscdk-resources-mongodbatlas.DataSource": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DataSource" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DataSource", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 508 }, "name": "DataSource", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DataSource#AllowInsecure" }, "remarks": "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.", "stability": "stable", "summary": "Flag that validates the scheme in the specified URLs." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 514 }, "name": "allowInsecure", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#Collection" }, "remarks": "For creating a wildcard (*) collection, you must omit this parameter.", "stability": "stable", "summary": "Human-readable label that identifies the collection in the database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 521 }, "name": "collection", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#CollectionRegex" }, "remarks": "To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).", "stability": "stable", "summary": "Regex pattern to use for creating the wildcard (*) collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 528 }, "name": "collectionRegex", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#Database" }, "remarks": "You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.", "stability": "stable", "summary": "Human-readable label that identifies the database, which contains the collection in the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 535 }, "name": "database", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#DatabaseRegex" }, "remarks": "To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).", "stability": "stable", "summary": "Regex pattern to use for creating the wildcard (*) collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 542 }, "name": "databaseRegex", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#DefaultFormat" }, "stability": "stable", "summary": "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\"." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 549 }, "name": "defaultFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#Path" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 556 }, "name": "path", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#ProvenanceFieldName" }, "remarks": "MongoDB Cloud returns different fields in the results for each supported provider.", "stability": "stable", "summary": "Name for the field that includes the provenance of the documents in the results." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 563 }, "name": "provenanceFieldName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#StoreName" }, "stability": "stable", "summary": "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 570 }, "name": "storeName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DataSource#Urls" }, "remarks": "You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter.", "stability": "stable", "summary": "URLs of the publicly accessible data files." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 577 }, "name": "urls", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/federated-database-instance/index:DataSource" }, "awscdk-resources-mongodbatlas.Database": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Database" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Database", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 244 }, "name": "Database", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Database#Collections" }, "stability": "stable", "summary": "Array of collections and data sources that map to a stores data store." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 250 }, "name": "collections", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Collection" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "Database#MaxWildcardCollections" }, "remarks": "This only applies to S3 data sources.", "stability": "stable", "summary": "Maximum number of wildcard collections in the database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 257 }, "name": "maxWildcardCollections", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Database#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the database to which the data lake maps data." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 264 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Database#Views" }, "remarks": "This only applies to S3 data sources.", "stability": "stable", "summary": "Array of aggregation pipelines that apply to the collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 271 }, "name": "views", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.View" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/federated-database-instance/index:Database" }, "awscdk-resources-mongodbatlas.DatabaseConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DatabaseConfig" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatabaseConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 142 }, "name": "DatabaseConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#Collection" }, "remarks": "The\ntrigger listens to events from this collection.", "stability": "stable", "summary": "The name of a collection in the specified database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 166 }, "name": "collection", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#Database" }, "stability": "stable", "summary": "The name of a database in the linked data source." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 158 }, "name": "database", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#FullDocument" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 198 }, "name": "fullDocument", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#FullDocumentBeforeChange" }, "remarks": "You must enable [document\npreimages](https://www.mongodb.com/docs/atlas/app-services/mongodb/preimages/)\nfor your cluster to include these snapshots.", "stability": "stable", "summary": "If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 211 }, "name": "fullDocumentBeforeChange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#Match" }, "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 180 }, "name": "match", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#MaximumThroughput" }, "stability": "stable", "summary": "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)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 238 }, "name": "maximumThroughput", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#OperationTypes" }, "stability": "stable", "summary": "The type(s) of MongoDB change event that the trigger listens for." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 173 }, "name": "operationTypes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.DatabaseConfigOperationTypes" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#Project" }, "stability": "stable", "summary": "stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 187 }, "name": "project", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#ServiceId" }, "remarks": "See [Get a Data Source](#operation/adminGetService).", "stability": "stable", "summary": "The _id value of a linked MongoDB data source." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 151 }, "name": "serviceId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#SkipCatchupEvents" }, "stability": "stable", "summary": "If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 220 }, "name": "skipCatchupEvents", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#TolerateResumeErrors" }, "remarks": "All change stream events from when the Trigger was suspended until the Trigger\nresumes execution do not have the Trigger fire for them.", "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 231 }, "name": "tolerateResumeErrors", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "DatabaseConfig#Unordered" }, "remarks": "If `false`, event\nordering is enabled and the Trigger executes events\nserially.", "stability": "stable", "summary": "If `true`, event ordering is disabled and this Trigger can process events in parallel." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 248 }, "name": "unordered", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/trigger/index:DatabaseConfig" }, "awscdk-resources-mongodbatlas.DatabaseConfigOperationTypes": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "DatabaseConfigOperationTypes" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatabaseConfigOperationTypes", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 407 }, "members": [ { "docs": { "stability": "stable", "summary": "INSERT." }, "name": "INSERT" }, { "docs": { "stability": "stable", "summary": "UPDATE." }, "name": "UPDATE" }, { "docs": { "stability": "stable", "summary": "REPLACE." }, "name": "REPLACE" }, { "docs": { "stability": "stable", "summary": "DELETE." }, "name": "DELETE" } ], "name": "DatabaseConfigOperationTypes", "symbolId": "src/l1-resources/trigger/index:DatabaseConfigOperationTypes" }, "awscdk-resources-mongodbatlas.DatabaseUserProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "DatabaseUserProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatabaseUserProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 251 }, "name": "DatabaseUserProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "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`.", "memberof": "DatabaseUserProps", "type": "{user.CfnDatabaseUserPropsAwsiamType}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 263 }, "name": "awsiamType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsAwsiamType" } }, { "abstract": true, "docs": { "custom": { "description": "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`.", "memberof": "DatabaseUserProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 269 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "DatabaseUserProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 257 }, "name": "deleteAfterDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "DatabaseUserProps", "type": "{user.LabelDefinition[]}" }, "default": "admin", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 276 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.LabelDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "Method by which the provided username is authenticated. Default value is `NONE`.", "memberof": "DatabaseUserProps", "type": "{user.CfnDatabaseUserPropsLdapAuthType}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 282 }, "name": "ldapAuthType", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsLdapAuthType" } }, { "abstract": true, "docs": { "custom": { "description": "The user’s password. This field is not included in the entity returned from the server.", "memberof": "DatabaseUserProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 294 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "Unique 24-hexadecimal digit string that identifies your Atlas Project.", "memberof": "DatabaseUserProps", "type": "{string}" }, "default": "cdk-pwd", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 301 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "List that provides the pairings of one role with one applicable database.", "memberof": "DatabaseUserProps", "type": "{user.RoleDefinition[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 307 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.RoleDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.", "memberof": "DatabaseUserProps", "type": "{user.ScopeDefinition[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 313 }, "name": "scopes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ScopeDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "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.", "memberof": "DatabaseUserProps", "type": "{string}" }, "default": "cdk-user", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 320 }, "name": "username", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "Method that briefs who owns the certificate provided. Default value is `NONE`.", "memberof": "DatabaseUserProps", "type": "{user.CfnDatabaseUserPropsX509Type}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 288 }, "name": "x509Type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.CfnDatabaseUserPropsX509Type" } } ], "symbolId": "src/l3-resources/common/props:DatabaseUserProps" }, "awscdk-resources-mongodbatlas.DatadogIntegration": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatadogIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 55 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.DatadogIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 52 }, "name": "DatadogIntegration", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 53 }, "name": "cfnThirdPartyIntegration", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegration" } } ], "symbolId": "src/l2-resources/third-party-integration/datadogIntegration:DatadogIntegration" }, "awscdk-resources-mongodbatlas.DatadogIntegrationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatadogIntegrationProps", "interfaces": [ "awscdk-resources-mongodbatlas.ThirdPartyIntegrationProps" ], "kind": "interface", "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 30 }, "name": "DatadogIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Key that allows MongoDB Cloud to access your Datadog account." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 34 }, "name": "apiKey", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 39 }, "name": "region", "type": { "fqn": "awscdk-resources-mongodbatlas.DatadogRegion" } } ], "symbolId": "src/l2-resources/third-party-integration/datadogIntegration:DatadogIntegrationProps" }, "awscdk-resources-mongodbatlas.DatadogRegion": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.DatadogRegion", "kind": "enum", "locationInModule": { "filename": "src/l2-resources/third-party-integration/datadogIntegration.ts", "line": 23 }, "members": [ { "docs": { "stability": "stable" }, "name": "US" }, { "docs": { "stability": "stable" }, "name": "EU" }, { "docs": { "stability": "stable" }, "name": "US3" }, { "docs": { "stability": "stable" }, "name": "US5" } ], "name": "DatadogRegion", "symbolId": "src/l2-resources/third-party-integration/datadogIntegration:DatadogRegion" }, "awscdk-resources-mongodbatlas.DbRoleToExecute": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "DBRoleToExecute" }, "stability": "stable", "summary": "The name of a Built in or Custom DB Role to connect to an Atlas Cluster." }, "fqn": "awscdk-resources-mongodbatlas.DbRoleToExecute", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 133 }, "name": "DbRoleToExecute", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "DBRoleToExecute#Role" }, "remarks": "Can be a built in role or a custom role.", "stability": "stable", "summary": "The name of the role to use." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 139 }, "name": "role", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "DBRoleToExecute#Type" }, "remarks": "Can be either BuiltIn or Custom.", "stability": "stable", "summary": "Type of the DB role." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 146 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DbRoleToExecuteType" } } ], "symbolId": "src/l1-resources/stream-connection/index:DbRoleToExecute" }, "awscdk-resources-mongodbatlas.DbRoleToExecuteType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "DbRoleToExecuteType" }, "remarks": "Can be either BuiltIn or Custom.", "stability": "stable", "summary": "Type of the DB role." }, "fqn": "awscdk-resources-mongodbatlas.DbRoleToExecuteType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 270 }, "members": [ { "docs": { "stability": "stable", "summary": "BUILT_IN." }, "name": "BUILT_IN" }, { "docs": { "stability": "stable", "summary": "CUSTOM." }, "name": "CUSTOM" } ], "name": "DbRoleToExecuteType", "symbolId": "src/l1-resources/stream-connection/index:DbRoleToExecuteType" }, "awscdk-resources-mongodbatlas.DiskGb": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "diskGB" }, "stability": "stable", "summary": "Automatic cluster storage settings that apply to this cluster." }, "fqn": "awscdk-resources-mongodbatlas.DiskGb", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 807 }, "name": "DiskGb", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "diskGB#Enabled" }, "remarks": "The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling.", "stability": "stable", "summary": "Flag that indicates whether this cluster enables disk auto-scaling." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 813 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/cluster/index:DiskGb" }, "awscdk-resources-mongodbatlas.EncryptionAtRestProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.EncryptionAtRestProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 101 }, "name": "EncryptionAtRestProps", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "AwsKms#CustomerMasterKeyID" }, "stability": "stable", "summary": "The AWS customer master key used to encrypt and decrypt the MongoDB master keys." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 113 }, "name": "customerMasterKeyId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#RoleID" }, "stability": "stable", "summary": "ID of an AWS IAM role authorized to manage an AWS customer master key." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 107 }, "name": "roleId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#Enabled" }, "remarks": "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.\nDefault Value: true", "stability": "stable", "summary": "Specifies whether Encryption at Rest is enabled for an Atlas project." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 119 }, "name": "enabledEncryptionAtRest", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "AwsKms#Region" }, "stability": "stable", "summary": "The AWS region in which the AWS customer master key exists." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/encryption-at-rest-express/index.ts", "line": 126 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/encryption-at-rest-express/index:EncryptionAtRestProps" }, "awscdk-resources-mongodbatlas.Event": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Event" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Event", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 370 }, "name": "Event", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Event#AWSEVENTBRIDGE" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 379 }, "name": "awseventbridge", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.EventAwseventbridge" } }, { "abstract": true, "docs": { "custom": { "schema": "Event#FUNCTION" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 374 }, "name": "function", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.EventFunction" } } ], "symbolId": "src/l1-resources/trigger/index:Event" }, "awscdk-resources-mongodbatlas.EventAwseventbridge": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "EventAwseventbridge" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.EventAwseventbridge", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 488 }, "name": "EventAwseventbridge", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "EventAwseventbridge#AWSConfig" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 492 }, "name": "awsConfig", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.EventAwseventbridgeAwsConfig" } } ], "symbolId": "src/l1-resources/trigger/index:EventAwseventbridge" }, "awscdk-resources-mongodbatlas.EventAwseventbridgeAwsConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "EventAwseventbridgeAwsConfig" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.EventAwseventbridgeAwsConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 573 }, "name": "EventAwseventbridgeAwsConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "EventAwseventbridgeAwsConfig#AccountId" }, "stability": "stable", "summary": "An AWS Account ID." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 579 }, "name": "accountId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "EventAwseventbridgeAwsConfig#ExtendedJsonEnabled" }, "stability": "stable", "summary": "If `true`, event objects are serialized using EJSON." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 593 }, "name": "extendedJsonEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "EventAwseventbridgeAwsConfig#Region" }, "stability": "stable", "summary": "An AWS region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 586 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/trigger/index:EventAwseventbridgeAwsConfig" }, "awscdk-resources-mongodbatlas.EventFunction": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "EventFunction" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.EventFunction", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 457 }, "name": "EventFunction", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "EventFunction#FuncConfig" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 461 }, "name": "funcConfig", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.EventFunctionFuncConfig" } } ], "symbolId": "src/l1-resources/trigger/index:EventFunction" }, "awscdk-resources-mongodbatlas.EventFunctionFuncConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "EventFunctionFuncConfig" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.EventFunctionFuncConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 519 }, "name": "EventFunctionFuncConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "EventFunctionFuncConfig#FunctionId" }, "remarks": "This value is the same as the root-level `function_id`.\nYou can either define the value here or in `function_id`.\nThe App Services backend duplicates the value to the configuration location where you did not define it.\n\nFor example, if you define `event_processors.FUNCTION.function_id`, the backend duplicates it to `function_id`.", "stability": "stable", "summary": "The ID of the function that the trigger calls when it fires." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 531 }, "name": "functionId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "EventFunctionFuncConfig#FunctionName" }, "remarks": "This value is the same as the root-level `function_name`.\nYou can either define the value here or in `function_name`.\nThe App Services backend duplicates the value to the configuration location where you did not define it.\n\nFor example, if you define `event_processors.FUNCTION.function_name`, the backend duplicates it to `function_name`.", "stability": "stable", "summary": "The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 545 }, "name": "functionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/trigger/index:EventFunctionFuncConfig" }, "awscdk-resources-mongodbatlas.Export": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Export" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Export", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 159 }, "name": "Export", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Export#ExportBucketId" }, "stability": "stable", "summary": "Unique identifier of the AWS bucket to export the cloud backup snapshot to." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 165 }, "name": "exportBucketId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Export#FrequencyType" }, "remarks": "Value can be daily, weekly, monthly or yearly.", "stability": "stable", "summary": "Frequency associated with the export policy." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 172 }, "name": "frequencyType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:Export" }, "awscdk-resources-mongodbatlas.Filter": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Filter" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Filter", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 67 }, "name": "Filter", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Filter#CloudProvider" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 71 }, "name": "cloudProvider", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.FilterCloudProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "Filter#Region" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 76 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Filter#Type" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 81 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster-outage-simulation/index:Filter" }, "awscdk-resources-mongodbatlas.FilterCloudProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "FilterCloudProvider" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.FilterCloudProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/cluster-outage-simulation/index.ts", "line": 110 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" } ], "name": "FilterCloudProvider", "symbolId": "src/l1-resources/cluster-outage-simulation/index:FilterCloudProvider" }, "awscdk-resources-mongodbatlas.InheritedRole": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "InheritedRole" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.InheritedRole", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 116 }, "name": "InheritedRole", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "InheritedRole#Db" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 120 }, "name": "db", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "InheritedRole#Role" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 125 }, "name": "role", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/custom-db-role/index:InheritedRole" }, "awscdk-resources-mongodbatlas.IntegerThresholdView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "IntegerThresholdView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.IntegerThresholdView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 471 }, "name": "IntegerThresholdView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "IntegerThresholdView#Operator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 477 }, "name": "operator", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.IntegerThresholdViewOperator" } }, { "abstract": true, "docs": { "custom": { "schema": "IntegerThresholdView#Threshold" }, "stability": "stable", "summary": "Value of metric that, when exceeded, triggers an alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 484 }, "name": "threshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "IntegerThresholdView#Units" }, "remarks": "This can be an element of time, storage capacity, and the like.", "stability": "stable", "summary": "Element used to express the quantity." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 491 }, "name": "units", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/alert-configuration/index:IntegerThresholdView" }, "awscdk-resources-mongodbatlas.IntegerThresholdViewOperator": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "IntegerThresholdViewOperator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value." }, "fqn": "awscdk-resources-mongodbatlas.IntegerThresholdViewOperator", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 698 }, "members": [ { "docs": { "stability": "stable", "summary": "GREATER_THAN." }, "name": "GREATER_THAN" }, { "docs": { "stability": "stable", "summary": "LESS_THAN." }, "name": "LESS_THAN" } ], "name": "IntegerThresholdViewOperator", "symbolId": "src/l1-resources/alert-configuration/index:IntegerThresholdViewOperator" }, "awscdk-resources-mongodbatlas.IpAccessListProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.", "export": "true", "interface": "IpAccessListProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.IpAccessListProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 327 }, "name": "IpAccessListProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "IpAccessListProps", "type": "{ipAccessList.AccessListDefinition[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 333 }, "name": "accessList", "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.AccessListDefinition" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "IpAccessListProps", "type": "{ipAccessList.ListOptions}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 352 }, "name": "listOptions", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ListOptions" } }, { "abstract": true, "docs": { "custom": { "description": "Unique 24-hexadecimal digit string that identifies your project.", "memberof": "IpAccessListProps", "type": "{string}" }, "default": "allow-all", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 340 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "Number of documents returned in this response.", "memberof": "IpAccessListProps", "type": "{number}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 346 }, "name": "totalCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l3-resources/common/props:IpAccessListProps" }, "awscdk-resources-mongodbatlas.LabelDefinition": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "labelDefinition" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.LabelDefinition", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 145 }, "name": "LabelDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "labelDefinition#Key" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 149 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "labelDefinition#Value" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 154 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/database-user/index:LabelDefinition" }, "awscdk-resources-mongodbatlas.Link": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Link" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Link", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 353 }, "name": "Link", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Link#Href" }, "remarks": "This URL often begins with `https://mms.mongodb.com`.", "stability": "stable", "summary": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 359 }, "name": "href", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Link#Rel" }, "remarks": "This URL often begins with `https://mms.mongodb.com`.", "stability": "stable", "summary": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-schedule/index.ts", "line": 366 }, "name": "rel", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cloud-backup-schedule/index:Link" }, "awscdk-resources-mongodbatlas.ListOptions": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "listOptions" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ListOptions", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 136 }, "name": "ListOptions", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "listOptions#IncludeCount" }, "stability": "stable", "summary": "Flag that indicates whether the response returns the total number of items (totalCount) in the response." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 156 }, "name": "includeCount", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "listOptions#ItemsPerPage" }, "stability": "stable", "summary": "Number of items that the response returns per page." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 149 }, "name": "itemsPerPage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "listOptions#PageNum" }, "stability": "stable", "summary": "Number of the page that displays the current set of the total objects that the response returns." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project-ip-access-list/index.ts", "line": 142 }, "name": "pageNum", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/project-ip-access-list/index:ListOptions" }, "awscdk-resources-mongodbatlas.ManagedNamespace": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "managedNamespace" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ManagedNamespace", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 83 }, "name": "ManagedNamespace", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "managedNamespace#Collection" }, "stability": "stable", "summary": "Human-readable label of the collection to manage for this Global Cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 89 }, "name": "collection", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "managedNamespace#CustomShardKey" }, "remarks": "Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", "stability": "stable", "summary": "Database parameter used to divide the *collection* into shards." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 96 }, "name": "customShardKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "managedNamespace#Db" }, "stability": "stable", "summary": "Human-readable label of the database to manage for this Global Cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 103 }, "name": "db", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "managedNamespace#IsCustomShardKeyHashed" }, "remarks": "If you set this value to `false`, MongoDB Cloud uses ranged sharding.", "stability": "stable", "summary": "Flag that indicates whether someone hashed the custom shard key for the specified collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 110 }, "name": "isCustomShardKeyHashed", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "managedNamespace#IsShardKeyUnique" }, "stability": "stable", "summary": "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/)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 117 }, "name": "isShardKeyUnique", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/global-cluster-config/index:ManagedNamespace" }, "awscdk-resources-mongodbatlas.Matcher": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Matcher" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Matcher", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 99 }, "name": "Matcher", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Matcher#FieldName" }, "remarks": "The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "stability": "stable", "summary": "Name of the parameter in the target object that MongoDB Cloud checks." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 105 }, "name": "fieldName", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MatcherFieldName" } }, { "abstract": true, "docs": { "custom": { "schema": "Matcher#Operator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value against **matcher[n].value**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 112 }, "name": "operator", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MatcherOperator" } }, { "abstract": true, "docs": { "custom": { "schema": "Matcher#Value" }, "stability": "stable", "summary": "Value to match or exceed using the specified **matchers.operator**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 119 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/alert-configuration/index:Matcher" }, "awscdk-resources-mongodbatlas.MatcherFieldName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "MatcherFieldName" }, "remarks": "The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "stability": "stable", "summary": "Name of the parameter in the target object that MongoDB Cloud checks." }, "fqn": "awscdk-resources-mongodbatlas.MatcherFieldName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 522 }, "members": [ { "docs": { "stability": "stable", "summary": "CLUSTER_NAME." }, "name": "CLUSTER_NAME" }, { "docs": { "stability": "stable", "summary": "HOSTNAME." }, "name": "HOSTNAME" }, { "docs": { "stability": "stable", "summary": "HOSTNAME_AND_PORT." }, "name": "HOSTNAME_AND_PORT" }, { "docs": { "stability": "stable", "summary": "PORT." }, "name": "PORT" }, { "docs": { "stability": "stable", "summary": "REPLICA_SET_NAME." }, "name": "REPLICA_SET_NAME" }, { "docs": { "stability": "stable", "summary": "SHARD_NAME." }, "name": "SHARD_NAME" }, { "docs": { "stability": "stable", "summary": "TYPE_NAME." }, "name": "TYPE_NAME" }, { "docs": { "stability": "stable", "summary": "APPLICATION_ID." }, "name": "APPLICATION_ID" }, { "docs": { "stability": "stable", "summary": "INSTANCE_NAME." }, "name": "INSTANCE_NAME" }, { "docs": { "stability": "stable", "summary": "PROCESSOR_NAME." }, "name": "PROCESSOR_NAME" } ], "name": "MatcherFieldName", "symbolId": "src/l1-resources/alert-configuration/index:MatcherFieldName" }, "awscdk-resources-mongodbatlas.MatcherOperator": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "MatcherOperator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value against **matcher[n].value**." }, "fqn": "awscdk-resources-mongodbatlas.MatcherOperator", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 550 }, "members": [ { "docs": { "stability": "stable", "summary": "EQUALS." }, "name": "EQUALS" }, { "docs": { "stability": "stable", "summary": "CONTAINS." }, "name": "CONTAINS" }, { "docs": { "stability": "stable", "summary": "STARTS_WITH." }, "name": "STARTS_WITH" }, { "docs": { "stability": "stable", "summary": "ENDS_WITH." }, "name": "ENDS_WITH" }, { "docs": { "stability": "stable", "summary": "NOT_EQUALS." }, "name": "NOT_EQUALS" }, { "docs": { "stability": "stable", "summary": "NOT_CONTAINS." }, "name": "NOT_CONTAINS" }, { "docs": { "stability": "stable", "summary": "REGEX." }, "name": "REGEX" } ], "name": "MatcherOperator", "symbolId": "src/l1-resources/alert-configuration/index:MatcherOperator" }, "awscdk-resources-mongodbatlas.MetricThresholdView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "MetricThresholdView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.MetricThresholdView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 148 }, "name": "MetricThresholdView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "MetricThresholdView#MetricName" }, "stability": "stable", "summary": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 154 }, "name": "metricName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "MetricThresholdView#Mode" }, "stability": "stable", "summary": "MongoDB Cloud computes the current metric value as an average." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 161 }, "name": "mode", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MetricThresholdViewMode" } }, { "abstract": true, "docs": { "custom": { "schema": "MetricThresholdView#Operator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 168 }, "name": "operator", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MetricThresholdViewOperator" } }, { "abstract": true, "docs": { "custom": { "schema": "MetricThresholdView#Threshold" }, "stability": "stable", "summary": "Value of metric that, when exceeded, triggers an alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 175 }, "name": "threshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "MetricThresholdView#Units" }, "remarks": "This can be an element of time, storage capacity, and the like.", "stability": "stable", "summary": "Element used to express the quantity." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 182 }, "name": "units", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/alert-configuration/index:MetricThresholdView" }, "awscdk-resources-mongodbatlas.MetricThresholdViewMode": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "MetricThresholdViewMode" }, "stability": "stable", "summary": "MongoDB Cloud computes the current metric value as an average." }, "fqn": "awscdk-resources-mongodbatlas.MetricThresholdViewMode", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 572 }, "members": [ { "docs": { "stability": "stable", "summary": "AVERAGE." }, "name": "AVERAGE" } ], "name": "MetricThresholdViewMode", "symbolId": "src/l1-resources/alert-configuration/index:MetricThresholdViewMode" }, "awscdk-resources-mongodbatlas.MetricThresholdViewOperator": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "MetricThresholdViewOperator" }, "stability": "stable", "summary": "Comparison operator to apply when checking the current metric value." }, "fqn": "awscdk-resources-mongodbatlas.MetricThresholdViewOperator", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 582 }, "members": [ { "docs": { "stability": "stable", "summary": "GREATER_THAN." }, "name": "GREATER_THAN" }, { "docs": { "stability": "stable", "summary": "LESS_THAN." }, "name": "LESS_THAN" } ], "name": "MetricThresholdViewOperator", "symbolId": "src/l1-resources/alert-configuration/index:MetricThresholdViewOperator" }, "awscdk-resources-mongodbatlas.MicrosoftTeamsIntegration": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.MicrosoftTeamsIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l2-resources/third-party-integration/microsoftTeamsIntegration.ts", "line": 41 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.MicrosoftTeamsIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l2-resources/third-party-integration/microsoftTeamsIntegration.ts", "line": 38 }, "name": "MicrosoftTeamsIntegration", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/microsoftTeamsIntegration.ts", "line": 39 }, "name": "cfnThirdPartyIntegration", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegration" } } ], "symbolId": "src/l2-resources/third-party-integration/microsoftTeamsIntegration:MicrosoftTeamsIntegration" }, "awscdk-resources-mongodbatlas.MicrosoftTeamsIntegrationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.MicrosoftTeamsIntegrationProps", "interfaces": [ "awscdk-resources-mongodbatlas.ThirdPartyIntegrationProps" ], "kind": "interface", "locationInModule": { "filename": "src/l2-resources/third-party-integration/microsoftTeamsIntegration.ts", "line": 23 }, "name": "MicrosoftTeamsIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/microsoftTeamsIntegration.ts", "line": 28 }, "name": "microsoftTeamsWebhookUrl", "type": { "primitive": "string" } } ], "symbolId": "src/l2-resources/third-party-integration/microsoftTeamsIntegration:MicrosoftTeamsIntegrationProps" }, "awscdk-resources-mongodbatlas.MongoAtlasBootstrap": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html", "stability": "stable", "summary": "Generate the CFN extension execution role." }, "fqn": "awscdk-resources-mongodbatlas.MongoAtlasBootstrap", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 46 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.MongoAtlasBootstrapProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 44 }, "name": "MongoAtlasBootstrap", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 45 }, "name": "role", "type": { "fqn": "aws-cdk-lib.aws_iam.IRole" } } ], "symbolId": "src/l3-resources/atlas-bootstrap/index:MongoAtlasBootstrap" }, "awscdk-resources-mongodbatlas.MongoAtlasBootstrapProps": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.MongoAtlasBootstrapProps", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 18 }, "name": "MongoAtlasBootstrapProps", "properties": [ { "docs": { "default": "auto generat the name.", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html", "stability": "stable", "summary": "The IAM role name for CloudFormation Extension Execution." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 24 }, "name": "roleName", "type": { "primitive": "string" } }, { "docs": { "default": "generate a dummy secret.", "see": "https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master#2-configure-your-profile", "stability": "stable", "summary": "The secret profile name for MongoDB Atlas." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 30 }, "name": "secretProfile", "type": { "primitive": "string" } }, { "docs": { "example": "typesToActivate=[\"Cluster\",\"Project\"] this will actiate MongoDB::Atlas::Project && MongoDB::Atlas::Cluster", "remarks": "the exported AtlasBasicResources can be used for AtlasBasic resources\nif not provided non resources will be activated", "stability": "stable", "summary": "List of strings representing mongoDB atlas types to activate." }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 37 }, "name": "typesToActivate", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l3-resources/atlas-bootstrap/index:MongoAtlasBootstrapProps" }, "awscdk-resources-mongodbatlas.MongoSecretProfile": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.MongoSecretProfile", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 110 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "profileName", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l3-resources/atlas-bootstrap/index.ts", "line": 109 }, "name": "MongoSecretProfile", "symbolId": "src/l3-resources/atlas-bootstrap/index:MongoSecretProfile" }, "awscdk-resources-mongodbatlas.NotificationView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "NotificationView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.NotificationView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 213 }, "name": "NotificationView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "NotificationView#ApiToken" }, "remarks": "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.", "stability": "stable", "summary": "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 219 }, "name": "apiToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#ChannelName" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"SLACK\"'.", "stability": "stable", "summary": "Name of the Slack channel to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 226 }, "name": "channelName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#DatadogApiKey" }, "remarks": "You can find this API key in the Datadog dashboard. The resource requires this parameter when '\"notifications.typeName\" : \"DATADOG\"'.", "stability": "stable", "summary": "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 233 }, "name": "datadogApiKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#DatadogRegion" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"DATADOG\"'.", "stability": "stable", "summary": "Datadog region that indicates which API Uniform Resource Locator (URL) to use." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 240 }, "name": "datadogRegion", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.NotificationViewDatadogRegion" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#DelayMin" }, "stability": "stable", "summary": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 247 }, "name": "delayMin", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#EmailAddress" }, "remarks": "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:\n\n- specific MongoDB Cloud users ('\"notifications.typeName\" : \"USER\"')\n- MongoDB Cloud users with specific project roles ('\"notifications.typeName\" : \"GROUP\"')\n- MongoDB Cloud users with specific organization roles ('\"notifications.typeName\" : \"ORG\"')\n- MongoDB Cloud teams ('\"notifications.typeName\" : \"TEAM\"')\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.emailEnabled** parameter.", "stability": "stable", "summary": "Email address to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 261 }, "name": "emailAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#EmailEnabled" }, "remarks": "The resource requires this parameter when one of the following values have been set:\n\n- '\"notifications.typeName\" : \"ORG\"'\n- '\"notifications.typeName\" : \"GROUP\"'\n- '\"notifications.typeName\" : \"USER\"'", "stability": "stable", "summary": "Flag that indicates whether MongoDB Cloud should send email notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 272 }, "name": "emailEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#IntervalMin" }, "remarks": "PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "stability": "stable", "summary": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 281 }, "name": "intervalMin", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#MicrosoftTeamsWebhookUrl" }, "remarks": "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.", "stability": "stable", "summary": "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 288 }, "name": "microsoftTeamsWebhookUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#MobileNumber" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"SMS\"'.", "stability": "stable", "summary": "Mobile phone number to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 295 }, "name": "mobileNumber", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#NotificationToken" }, "remarks": "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.", "stability": "stable", "summary": "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 302 }, "name": "notificationToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#OpsGenieApiKey" }, "remarks": "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.", "stability": "stable", "summary": "API Key that MongoDB Cloud needs to send this notification via Opsgenie." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 309 }, "name": "opsGenieApiKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#OpsGenieRegion" }, "stability": "stable", "summary": "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 316 }, "name": "opsGenieRegion", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.NotificationViewOpsGenieRegion" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#OrgName" }, "remarks": "This name appears after 'www.flowdock.com/app/' in the Uniform Resource Locator (URL) path. The resource requires this parameter when '\"notifications.typeName\" : \"FLOWDOCK\"'.", "stability": "stable", "summary": "Flowdock organization name to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 323 }, "name": "orgName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#Roles" }, "remarks": "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.", "stability": "stable", "summary": "List that contains the one or more organization or project roles that receive the configured alert." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 330 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.NotificationViewRoles" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#RoomName" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"HIP_CHAT\"'\".", "stability": "stable", "summary": "HipChat API room name to which MongoDB Cloud sends alert notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 337 }, "name": "roomName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#ServiceKey" }, "remarks": "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.", "stability": "stable", "summary": "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 344 }, "name": "serviceKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#Severity" }, "stability": "stable", "summary": "Degree of seriousness given to this notification." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 351 }, "name": "severity", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.NotificationViewSeverity" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#SmsEnabled" }, "remarks": "The resource requires this parameter when one of the following values have been set:\n\n- '\"notifications.typeName\" : \"ORG\"'\n- '\"notifications.typeName\" : \"GROUP\"'\n- '\"notifications.typeName\" : \"USER\"'", "stability": "stable", "summary": "Flag that indicates whether MongoDB Cloud should send text message notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 362 }, "name": "smsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#TeamId" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"TEAM\"'.", "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 369 }, "name": "teamId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#TeamName" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"TEAM\"'.", "stability": "stable", "summary": "Name of the MongoDB Cloud team that receives this notification." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 376 }, "name": "teamName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#TypeName" }, "stability": "stable", "summary": "Human-readable label that displays the alert notification type." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 383 }, "name": "typeName", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.NotificationViewTypeName" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#Username" }, "remarks": "Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when '\"notifications.typeName\" : \"USER\"'.", "stability": "stable", "summary": "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 390 }, "name": "username", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#VictorOpsApiKey" }, "remarks": "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.", "stability": "stable", "summary": "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 397 }, "name": "victorOpsApiKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#VictorOpsRoutingKey" }, "remarks": "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.", "stability": "stable", "summary": "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 404 }, "name": "victorOpsRoutingKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#WebhookSecret" }, "stability": "stable", "summary": "An optional field for your webhook secret." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 411 }, "name": "webhookSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "NotificationView#WebhookUrl" }, "stability": "stable", "summary": "Your webhook URL." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 418 }, "name": "webhookUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/alert-configuration/index:NotificationView" }, "awscdk-resources-mongodbatlas.NotificationViewDatadogRegion": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "NotificationViewDatadogRegion" }, "remarks": "The resource requires this parameter when '\"notifications.typeName\" : \"DATADOG\"'.", "stability": "stable", "summary": "Datadog region that indicates which API Uniform Resource Locator (URL) to use." }, "fqn": "awscdk-resources-mongodbatlas.NotificationViewDatadogRegion", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 594 }, "members": [ { "docs": { "stability": "stable", "summary": "EU." }, "name": "EU" }, { "docs": { "stability": "stable", "summary": "US." }, "name": "US" } ], "name": "NotificationViewDatadogRegion", "symbolId": "src/l1-resources/alert-configuration/index:NotificationViewDatadogRegion" }, "awscdk-resources-mongodbatlas.NotificationViewOpsGenieRegion": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "NotificationViewOpsGenieRegion" }, "stability": "stable", "summary": "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use." }, "fqn": "awscdk-resources-mongodbatlas.NotificationViewOpsGenieRegion", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 606 }, "members": [ { "docs": { "stability": "stable", "summary": "EU." }, "name": "EU" }, { "docs": { "stability": "stable", "summary": "US." }, "name": "US" } ], "name": "NotificationViewOpsGenieRegion", "symbolId": "src/l1-resources/alert-configuration/index:NotificationViewOpsGenieRegion" }, "awscdk-resources-mongodbatlas.NotificationViewRoles": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "NotificationViewRoles" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.NotificationViewRoles", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 616 }, "members": [ { "docs": { "stability": "stable", "summary": "GROUP_CLUSTER_MANAGER." }, "name": "GROUP_CLUSTER_MANAGER" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_ADMIN." }, "name": "GROUP_DATA_ACCESS_ADMIN" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_ONLY." }, "name": "GROUP_DATA_ACCESS_READ_ONLY" }, { "docs": { "stability": "stable", "summary": "GROUP_DATA_ACCESS_READ_WRITE." }, "name": "GROUP_DATA_ACCESS_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "GROUP_OWNER." }, "name": "GROUP_OWNER" }, { "docs": { "stability": "stable", "summary": "GROUP_READ_WRITE." }, "name": "GROUP_READ_WRITE" }, { "docs": { "stability": "stable", "summary": "ORG_OWNER." }, "name": "ORG_OWNER" }, { "docs": { "stability": "stable", "summary": "ORG_MEMBER." }, "name": "ORG_MEMBER" }, { "docs": { "stability": "stable", "summary": "ORG_GROUP_CREATOR." }, "name": "ORG_GROUP_CREATOR" }, { "docs": { "stability": "stable", "summary": "ORG_BILLING_ADMIN." }, "name": "ORG_BILLING_ADMIN" }, { "docs": { "stability": "stable", "summary": "ORG_READ_ONLY." }, "name": "ORG_READ_ONLY" } ], "name": "NotificationViewRoles", "symbolId": "src/l1-resources/alert-configuration/index:NotificationViewRoles" }, "awscdk-resources-mongodbatlas.NotificationViewSeverity": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "NotificationViewSeverity" }, "stability": "stable", "summary": "Degree of seriousness given to this notification." }, "fqn": "awscdk-resources-mongodbatlas.NotificationViewSeverity", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 646 }, "members": [ { "docs": { "stability": "stable", "summary": "CRITICAL." }, "name": "CRITICAL" }, { "docs": { "stability": "stable", "summary": "ERROR." }, "name": "ERROR" }, { "docs": { "stability": "stable", "summary": "WARNING." }, "name": "WARNING" } ], "name": "NotificationViewSeverity", "symbolId": "src/l1-resources/alert-configuration/index:NotificationViewSeverity" }, "awscdk-resources-mongodbatlas.NotificationViewTypeName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "NotificationViewTypeName" }, "stability": "stable", "summary": "Human-readable label that displays the alert notification type." }, "fqn": "awscdk-resources-mongodbatlas.NotificationViewTypeName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/alert-configuration/index.ts", "line": 660 }, "members": [ { "docs": { "stability": "stable", "summary": "DATADOG." }, "name": "DATADOG" }, { "docs": { "stability": "stable", "summary": "EMAIL." }, "name": "EMAIL" }, { "docs": { "stability": "stable", "summary": "FLOWDOCK." }, "name": "FLOWDOCK" }, { "docs": { "stability": "stable", "summary": "GROUP." }, "name": "GROUP" }, { "docs": { "stability": "stable", "summary": "MICROSOFT_TEAMS." }, "name": "MICROSOFT_TEAMS" }, { "docs": { "stability": "stable", "summary": "OPS_GENIE." }, "name": "OPS_GENIE" }, { "docs": { "stability": "stable", "summary": "ORG." }, "name": "ORG" }, { "docs": { "stability": "stable", "summary": "PAGER_DUTY." }, "name": "PAGER_DUTY" }, { "docs": { "stability": "stable", "summary": "PROMETHEUS." }, "name": "PROMETHEUS" }, { "docs": { "stability": "stable", "summary": "SLACK." }, "name": "SLACK" }, { "docs": { "stability": "stable", "summary": "SMS." }, "name": "SMS" }, { "docs": { "stability": "stable", "summary": "TEAM." }, "name": "TEAM" }, { "docs": { "stability": "stable", "summary": "USER." }, "name": "USER" }, { "docs": { "stability": "stable", "summary": "VICTOR_OPS." }, "name": "VICTOR_OPS" }, { "docs": { "stability": "stable", "summary": "WEBHOOK." }, "name": "WEBHOOK" } ], "name": "NotificationViewTypeName", "symbolId": "src/l1-resources/alert-configuration/index:NotificationViewTypeName" }, "awscdk-resources-mongodbatlas.PagerDutyIntegration": { "assembly": "awscdk-resources-mongodbatlas", "base": "constructs.Construct", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PagerDutyIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 53 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "awscdk-resources-mongodbatlas.PagerDutyIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 50 }, "name": "PagerDutyIntegration", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 51 }, "name": "cfnThirdPartyIntegration", "type": { "fqn": "awscdk-resources-mongodbatlas.CfnThirdPartyIntegration" } } ], "symbolId": "src/l2-resources/third-party-integration/pagerDutyIntegration:PagerDutyIntegration" }, "awscdk-resources-mongodbatlas.PagerDutyIntegrationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PagerDutyIntegrationProps", "interfaces": [ "awscdk-resources-mongodbatlas.ThirdPartyIntegrationProps" ], "kind": "interface", "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 28 }, "name": "PagerDutyIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 37 }, "name": "region", "type": { "fqn": "awscdk-resources-mongodbatlas.PagerDutyRegion" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Service key associated with your PagerDuty account." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 32 }, "name": "serviceKey", "type": { "primitive": "string" } } ], "symbolId": "src/l2-resources/third-party-integration/pagerDutyIntegration:PagerDutyIntegrationProps" }, "awscdk-resources-mongodbatlas.PagerDutyRegion": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PagerDutyRegion", "kind": "enum", "locationInModule": { "filename": "src/l2-resources/third-party-integration/pagerDutyIntegration.ts", "line": 23 }, "members": [ { "docs": { "stability": "stable" }, "name": "US" }, { "docs": { "stability": "stable" }, "name": "EU" } ], "name": "PagerDutyRegion", "symbolId": "src/l2-resources/third-party-integration/pagerDutyIntegration:PagerDutyRegion" }, "awscdk-resources-mongodbatlas.PartitionFieldView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "PartitionFieldView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PartitionFieldView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 218 }, "name": "PartitionFieldView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "PartitionFieldView#FieldName" }, "remarks": "To specify a nested parameter, use the dot notation.", "stability": "stable", "summary": "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 224 }, "name": "fieldName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "PartitionFieldView#Order" }, "remarks": "The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence.", "stability": "stable", "summary": "Sequence in which MongoDB Cloud slices the collection data to create partitions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 231 }, "name": "order", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/online-archive/index:PartitionFieldView" }, "awscdk-resources-mongodbatlas.PartitionFields": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "partitionFields" }, "stability": "stable", "summary": "Ordered fields used to physically organize data in the destination." }, "fqn": "awscdk-resources-mongodbatlas.PartitionFields", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 268 }, "name": "PartitionFields", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "partitionFields#FieldName" }, "stability": "stable", "summary": "Human-readable label that identifies the field name used to partition data." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 274 }, "name": "fieldName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "partitionFields#Order" }, "remarks": "The resource expresses this sequence starting with zero.", "stability": "stable", "summary": "Sequence in which MongoDB Cloud slices the collection data to create partitions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 281 }, "name": "order", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:PartitionFields" }, "awscdk-resources-mongodbatlas.PrivateEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "PrivateEndpoint" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PrivateEndpoint", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 93 }, "name": "PrivateEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "PrivateEndpoint#AtlasPrivateEndpointStatus" }, "stability": "stable", "summary": "Status of the Atlas PrivateEndpoint connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 127 }, "name": "atlasPrivateEndpointStatus", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "PrivateEndpoint#AWSPrivateEndpointStatus" }, "stability": "stable", "summary": "Status of the AWS PrivateEndpoint connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 120 }, "name": "awsPrivateEndpointStatus", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "PrivateEndpoint#InterfaceEndpointId" }, "stability": "stable", "summary": "Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 113 }, "name": "interfaceEndpointId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "PrivateEndpoint#SubnetIds" }, "stability": "stable", "summary": "List of string representing the AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 106 }, "name": "subnetIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "PrivateEndpoint#VpcId" }, "stability": "stable", "summary": "String Representing the AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/private-endpoint/index.ts", "line": 99 }, "name": "vpcId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/private-endpoint/index:PrivateEndpoint" }, "awscdk-resources-mongodbatlas.PrivateEndpointProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "PrivateEndpointProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.PrivateEndpointProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 143 }, "name": "PrivateEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)", "memberof": "PrivateEndpointProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 155 }, "name": "awsSubnetId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)", "memberof": "PrivateEndpointProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/atlas-basic-private-endpoint/index.ts", "line": 149 }, "name": "awsVpcId", "type": { "primitive": "string" } } ], "symbolId": "src/l3-resources/atlas-basic-private-endpoint/index:PrivateEndpointProps" }, "awscdk-resources-mongodbatlas.ProcessArgs": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "processArgs" }, "stability": "stable", "summary": "Advanced configuration details to add for one cluster in the specified project." }, "fqn": "awscdk-resources-mongodbatlas.ProcessArgs", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 197 }, "name": "ProcessArgs", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "processArgs#DefaultReadConcern" }, "stability": "stable", "summary": "Default level of acknowledgment requested from MongoDB for read operations set for this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 203 }, "name": "defaultReadConcern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#DefaultWriteConcern" }, "stability": "stable", "summary": "Default level of acknowledgment requested from MongoDB for write operations set for this cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 210 }, "name": "defaultWriteConcern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#FailIndexKeyTooLong" }, "remarks": "If you set this to false, mongod writes documents that exceed this limit but doesn't index them.", "stability": "stable", "summary": "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 217 }, "name": "failIndexKeyTooLong", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#JavascriptEnabled" }, "stability": "stable", "summary": "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 224 }, "name": "javascriptEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#MinimumEnabledTLSProtocol" }, "remarks": "Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", "stability": "stable", "summary": "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 231 }, "name": "minimumEnabledTlsProtocol", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#NoTableScan" }, "stability": "stable", "summary": "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 238 }, "name": "noTableScan", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#OplogMinRetentionHours" }, "remarks": "A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", "stability": "stable", "summary": "Minimum retention window for cluster's oplog expressed in hours." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 266 }, "name": "oplogMinRetentionHours", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#OplogSizeMB" }, "remarks": "A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", "stability": "stable", "summary": "Storage limit of cluster's oplog expressed in megabytes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 245 }, "name": "oplogSizeMb", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#SampleRefreshIntervalBIConnector" }, "stability": "stable", "summary": "Number of documents per database to sample when gathering schema information." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 259 }, "name": "sampleRefreshIntervalBiConnector", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#SampleSizeBIConnector" }, "stability": "stable", "summary": "Interval in seconds at which the mongosqld process re-samples data to create its relational schema." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 252 }, "name": "sampleSizeBiConnector", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "processArgs#TransactionLifetimeLimitSeconds" }, "remarks": "Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", "stability": "stable", "summary": "Lifetime, in seconds, of multi-document transactions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 273 }, "name": "transactionLifetimeLimitSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/cluster/index:ProcessArgs" }, "awscdk-resources-mongodbatlas.ProjectApiKey": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "projectApiKey" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ProjectApiKey", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 226 }, "name": "ProjectApiKey", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "projectApiKey#Key" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 232 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "projectApiKey#RoleNames" }, "remarks": "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\"", "stability": "stable", "summary": "List of roles to grant this API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 239 }, "name": "roleNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/project/index:ProjectApiKey" }, "awscdk-resources-mongodbatlas.ProjectAssignment": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ProjectAssignment" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ProjectAssignment", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 97 }, "name": "ProjectAssignment", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ProjectAssignment#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the project in an organization." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 110 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ProjectAssignment#Roles" }, "remarks": "If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", "stability": "stable", "summary": "List of roles to grant this API key." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/api-key/index.ts", "line": 103 }, "name": "roles", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/api-key/index:ProjectAssignment" }, "awscdk-resources-mongodbatlas.ProjectProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "description": "true", "export": "true", "interface": "ProjectProps" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ProjectProps", "kind": "interface", "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 84 }, "name": "ProjectProps", "properties": [ { "abstract": true, "docs": { "custom": { "description": "Unique identifier of the organization within which to create the project.", "memberof": "ProjectProps", "type": "{string}" }, "default": "auto-generated", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 97 }, "name": "orgId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "The number of Atlas clusters deployed in the project.", "memberof": "ProjectProps", "type": "{number}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 115 }, "name": "clusterCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "description": "Name of the project to create.", "memberof": "ProjectProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 90 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "ProjectProps", "type": "{project.ProjectApiKey[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 133 }, "name": "projectApiKeys", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ProjectApiKey" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the `Project Owner` role on the specified project. If you set this parameter, it overrides the default value of the oldest `Organization Owner`.", "memberof": "ProjectProps", "type": "{string}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 103 }, "name": "projectOwnerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "ProjectProps", "type": "{project.ProjectSettings}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 121 }, "name": "projectSettings", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ProjectSettings" } }, { "abstract": true, "docs": { "custom": { "description": "true", "memberof": "ProjectProps", "type": "{project.ProjectTeam[]}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 127 }, "name": "projectTeams", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ProjectTeam" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "description": "Flag that indicates whether to create the project with default alert settings.", "memberof": "ProjectProps", "type": "{boolean}" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l3-resources/common/props.ts", "line": 109 }, "name": "withDefaultAlertsSettings", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l3-resources/common/props:ProjectProps" }, "awscdk-resources-mongodbatlas.ProjectSettings": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "projectSettings" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ProjectSettings", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 111 }, "name": "ProjectSettings", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsCollectDatabaseSpecificsStatisticsEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to collect database-specific metrics for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 117 }, "name": "isCollectDatabaseSpecificsStatisticsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsDataExplorerEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to enable the Data Explorer for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 124 }, "name": "isDataExplorerEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsExtendedStorageSizesEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to enable extended storage sizes for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 131 }, "name": "isExtendedStorageSizesEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsPerformanceAdvisorEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 138 }, "name": "isPerformanceAdvisorEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsRealtimePerformancePanelEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 145 }, "name": "isRealtimePerformancePanelEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "projectSettings#IsSchemaAdvisorEnabled" }, "stability": "stable", "summary": "Flag that indicates whether to enable the Schema Advisor for the specified project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 152 }, "name": "isSchemaAdvisorEnabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/project/index:ProjectSettings" }, "awscdk-resources-mongodbatlas.ProjectTeam": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "projectTeam" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ProjectTeam", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 185 }, "name": "ProjectTeam", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "projectTeam#RoleNames" }, "remarks": "tems Enum: \"GROUP_CLUSTER_MANAGER\" \"GROUP_DATA_ACCESS_ADMIN\" \"GROUP_DATA_ACCESS_READ_ONLY\" \"GROUP_DATA_ACCESS_READ_WRITE\" \"GROUP_OWNER\" \"GROUP_READ_ONLY\"", "stability": "stable", "summary": "One or more organization- or project-level roles to assign to the MongoDB Cloud user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 198 }, "name": "roleNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "projectTeam#TeamId" }, "remarks": "string = 24 characters ^([a-f0-9]{24})$", "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the team." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/project/index.ts", "line": 191 }, "name": "teamId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/project/index:ProjectTeam" }, "awscdk-resources-mongodbatlas.ReadPreference": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ReadPreference" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ReadPreference", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 458 }, "name": "ReadPreference", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ReadPreference#MaxStalenessSeconds" }, "stability": "stable", "summary": "Maximum replication lag, or staleness, for reads from secondaries." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 472 }, "name": "maxStalenessSeconds", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ReadPreference#Mode" }, "stability": "stable", "summary": "\"primary\" \"primaryPreferred\" \"secondary\" \"secondaryPreferred\" \"nearest\" Read preference mode that specifies to which replica set member to route the read requests." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 465 }, "name": "mode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ReadPreference#TagSets" }, "remarks": "If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", "stability": "stable", "summary": "List that contains tag sets or tag specification documents." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 479 }, "name": "tagSets", "optional": true, "type": { "collection": { "elementtype": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.TagSet" }, "kind": "array" } }, "kind": "array" } } } ], "symbolId": "src/l1-resources/federated-database-instance/index:ReadPreference" }, "awscdk-resources-mongodbatlas.Resource": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Resource" }, "stability": "stable", "summary": "List of resources on which you grant the action." }, "fqn": "awscdk-resources-mongodbatlas.Resource", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 155 }, "name": "Resource", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Resource#Cluster" }, "remarks": "If true, MongoDB Cloud ignores the actions.resources.collection and actions.resources.db parameters.", "stability": "stable", "summary": "Flag that indicates whether to grant the action on the cluster resource." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 175 }, "name": "cluster", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "Resource#Collection" }, "remarks": "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.", "stability": "stable", "summary": "Human-readable label that identifies the collection on which you grant the action to one MongoDB user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 161 }, "name": "collection", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Resource#DB" }, "remarks": "If you set \"actions.resources.cluster\" : true, MongoDB Cloud ignores this parameter.", "stability": "stable", "summary": "Human-readable label that identifies the database on which you grant the action to one MongoDB user." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/custom-db-role/index.ts", "line": 168 }, "name": "db", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/custom-db-role/index:Resource" }, "awscdk-resources-mongodbatlas.RoleAssignment": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "RoleAssignment" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.RoleAssignment", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 75 }, "name": "RoleAssignment", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "RoleAssignment#OrgId" }, "remarks": "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.\n\nThis parameter returns an empty object if no custom zones exist.", "stability": "stable", "summary": "List that contains comma-separated key value pairs to map zones to geographic regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 92 }, "name": "orgId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "RoleAssignment#ProjectId" }, "remarks": "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.\n\nThis parameter returns an empty object if no custom zones exist.", "stability": "stable", "summary": "List that contains comma-separated key value pairs to map zones to geographic regions." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 83 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "RoleAssignment#Role" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-settings-org-role-mapping/index.ts", "line": 97 }, "name": "role", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-settings-org-role-mapping/index:RoleAssignment" }, "awscdk-resources-mongodbatlas.RoleDefinition": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "roleDefinition" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.RoleDefinition", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 210 }, "name": "RoleDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "roleDefinition#CollectionName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 214 }, "name": "collectionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "roleDefinition#DatabaseName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 219 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "roleDefinition#RoleName" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 224 }, "name": "roleName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/database-user/index:RoleDefinition" }, "awscdk-resources-mongodbatlas.ScheduleConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ScheduleConfig" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ScheduleConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 327 }, "name": "ScheduleConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ScheduleConfig#Schedule" }, "stability": "stable", "summary": "A [cron expression](https://www.mongodb.com/docs/atlas/app-services/triggers/scheduled-triggers/#cron-expressions) that specifies when the trigger executes." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 333 }, "name": "schedule", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleConfig#SkipcatchupEvents" }, "stability": "stable", "summary": "If `true`, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/trigger/index.ts", "line": 342 }, "name": "skipcatchupEvents", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/l1-resources/trigger/index:ScheduleConfig" }, "awscdk-resources-mongodbatlas.ScheduleView": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ScheduleView" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ScheduleView", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 259 }, "name": "ScheduleView", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#DayOfMonth" }, "stability": "stable", "summary": "Day of the month when the scheduled archive starts." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 298 }, "name": "dayOfMonth", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#DayOfWeek" }, "stability": "stable", "summary": "Day of the month when the scheduled archive starts." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 305 }, "name": "dayOfWeek", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#EndHour" }, "stability": "stable", "summary": "Hour of the day when the scheduled window to run one online archive ends." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 270 }, "name": "endHour", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#EndMinute" }, "stability": "stable", "summary": "Minute of the hour when the scheduled window to run one online archive ends." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 277 }, "name": "endMinute", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#StartHour" }, "stability": "stable", "summary": "Hour of the day when the when the scheduled window to run one online archive starts." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 284 }, "name": "startHour", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#StartMinute" }, "stability": "stable", "summary": "Minute of the hour when the scheduled window to run one online archive starts." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 291 }, "name": "startMinute", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "ScheduleView#Type" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 263 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ScheduleViewType" } } ], "symbolId": "src/l1-resources/online-archive/index:ScheduleView" }, "awscdk-resources-mongodbatlas.ScheduleViewType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ScheduleViewType" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ScheduleViewType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/online-archive/index.ts", "line": 366 }, "members": [ { "docs": { "stability": "stable", "summary": "DAILY." }, "name": "DAILY" }, { "docs": { "stability": "stable", "summary": "MONTHLY." }, "name": "MONTHLY" }, { "docs": { "stability": "stable", "summary": "DEFAULT." }, "name": "DEFAULT" }, { "docs": { "stability": "stable", "summary": "WEEKLY." }, "name": "WEEKLY" } ], "name": "ScheduleViewType", "symbolId": "src/l1-resources/online-archive/index:ScheduleViewType" }, "awscdk-resources-mongodbatlas.ScopeDefinition": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "scopeDefinition" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ScopeDefinition", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 253 }, "name": "ScopeDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "scopeDefinition#Name" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 257 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "scopeDefinition#Type" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 262 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ScopeDefinitionType" } } ], "symbolId": "src/l1-resources/database-user/index:ScopeDefinition" }, "awscdk-resources-mongodbatlas.ScopeDefinitionType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ScopeDefinitionType" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ScopeDefinitionType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/database-user/index.ts", "line": 290 }, "members": [ { "docs": { "stability": "stable", "summary": "CLUSTER." }, "name": "CLUSTER" }, { "docs": { "stability": "stable", "summary": "DATA_LAKE." }, "name": "DATA_LAKE" } ], "name": "ScopeDefinitionType", "symbolId": "src/l1-resources/database-user/index:ScopeDefinitionType" }, "awscdk-resources-mongodbatlas.ServerlessInstanceConnectionStrings": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ServerlessInstanceConnectionStrings" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceConnectionStrings", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 119 }, "name": "ServerlessInstanceConnectionStrings", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstanceConnectionStrings#PrivateEndpoint" }, "remarks": "This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", "stability": "stable", "summary": "List of private endpoint connection strings that you can use to connect to this serverless instance through a private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 125 }, "name": "privateEndpoint", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstanceConnectionStrings#StandardSrv" }, "remarks": "This connection string uses the `mongodb+srv://` protocol.", "stability": "stable", "summary": "Public connection string that you can use to connect to this serverless instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 132 }, "name": "standardSrv", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstanceConnectionStrings" }, "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpoint" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpoint", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 203 }, "name": "ServerlessInstancePrivateEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpoint#Endpoints" }, "stability": "stable", "summary": "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 209 }, "name": "endpoints", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointEndpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpoint#SrvConnectionString" }, "remarks": "The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", "stability": "stable", "summary": "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 216 }, "name": "srvConnectionString", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpoint#Type" }, "stability": "stable", "summary": "MongoDB process type to which your application connects." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 224 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointType" } } ], "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstancePrivateEndpoint" }, "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointEndpoint": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpointEndpoint" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointEndpoint", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 265 }, "name": "ServerlessInstancePrivateEndpointEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpointEndpoint#EndpointId" }, "stability": "stable", "summary": "Unique provider identifier of the private endpoint." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 272 }, "name": "endpointId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpointEndpoint#ProviderName" }, "stability": "stable", "summary": "Cloud provider where the private endpoint is deployed." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 280 }, "name": "providerName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpointEndpoint#Region" }, "stability": "stable", "summary": "Region where the private endpoint is deployed." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 288 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstancePrivateEndpointEndpoint" }, "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ServerlessInstancePrivateEndpointType" }, "stability": "stable", "summary": "MongoDB process type to which your application connects." }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstancePrivateEndpointType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 320 }, "members": [ { "docs": { "stability": "stable", "summary": "MONGOS." }, "name": "MONGOS" } ], "name": "ServerlessInstancePrivateEndpointType", "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstancePrivateEndpointType" }, "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettings": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "ServerlessInstanceProviderSettings" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettings", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 162 }, "name": "ServerlessInstanceProviderSettings", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstanceProviderSettings#ProviderName" }, "stability": "stable", "summary": "Human-readable label that identifies the cloud service provider." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 168 }, "name": "providerName", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettingsProviderName" } }, { "abstract": true, "docs": { "custom": { "schema": "ServerlessInstanceProviderSettings#RegionName" }, "remarks": "The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", "stability": "stable", "summary": "Human-readable label that identifies the geographic location of your MongoDB serverless instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 175 }, "name": "regionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstanceProviderSettings" }, "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettingsProviderName": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "ServerlessInstanceProviderSettingsProviderName" }, "stability": "stable", "summary": "Human-readable label that identifies the cloud service provider." }, "fqn": "awscdk-resources-mongodbatlas.ServerlessInstanceProviderSettingsProviderName", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/serverless-instance/index.ts", "line": 257 }, "members": [ { "docs": { "stability": "stable", "summary": "SERVERLESS." }, "name": "SERVERLESS" } ], "name": "ServerlessInstanceProviderSettingsProviderName", "symbolId": "src/l1-resources/serverless-instance/index:ServerlessInstanceProviderSettingsProviderName" }, "awscdk-resources-mongodbatlas.Sink": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "sink" }, "stability": "stable", "summary": "Ingestion destination of a Data Lake Pipeline." }, "fqn": "awscdk-resources-mongodbatlas.Sink", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 89 }, "name": "Sink", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "sink#MetadataProvider" }, "stability": "stable", "summary": "Target cloud provider for this Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 102 }, "name": "metadataProvider", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "sink#MetadataRegion" }, "stability": "stable", "summary": "Target cloud provider region for this Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 109 }, "name": "metadataRegion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "sink#PartitionFields" }, "stability": "stable", "summary": "Ordered fields used to physically organize data in the destination." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 116 }, "name": "partitionFields", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.PartitionFields" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "sink#Type" }, "stability": "stable", "summary": "Type of ingestion destination of this Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 95 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.SinkType" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:Sink" }, "awscdk-resources-mongodbatlas.SinkType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "SinkType" }, "stability": "stable", "summary": "Type of ingestion destination of this Data Lake Pipeline." }, "fqn": "awscdk-resources-mongodbatlas.SinkType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 258 }, "members": [ { "docs": { "stability": "stable", "summary": "DLS." }, "name": "DLS" } ], "name": "SinkType", "symbolId": "src/l1-resources/data-lake-pipeline/index:SinkType" }, "awscdk-resources-mongodbatlas.Source": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "source" }, "stability": "stable", "summary": "Ingestion destination of a Data Lake Pipeline." }, "fqn": "awscdk-resources-mongodbatlas.Source", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 148 }, "name": "Source", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "source#ClusterName" }, "stability": "stable", "summary": "Human-readable name that identifies the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 161 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "source#CollectionName" }, "stability": "stable", "summary": "Human-readable name that identifies the collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 168 }, "name": "collectionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "source#DatabaseName" }, "stability": "stable", "summary": "Human-readable name that identifies the database." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 175 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "source#GroupId" }, "stability": "stable", "summary": "Unique 24-hexadecimal character string that identifies the project." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 182 }, "name": "groupId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "source#Type" }, "stability": "stable", "summary": "Type of ingestion source of this Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 154 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.SourceType" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:Source" }, "awscdk-resources-mongodbatlas.SourceType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "SourceType" }, "stability": "stable", "summary": "Type of ingestion source of this Data Lake Pipeline." }, "fqn": "awscdk-resources-mongodbatlas.SourceType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 311 }, "members": [ { "docs": { "stability": "stable", "summary": "ON_DEMAND_CPS." }, "name": "ON_DEMAND_CPS" }, { "docs": { "stability": "stable", "summary": "PERIODIC_CPS." }, "name": "PERIODIC_CPS" } ], "name": "SourceType", "symbolId": "src/l1-resources/data-lake-pipeline/index:SourceType" }, "awscdk-resources-mongodbatlas.Specs": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "specs" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Specs", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 737 }, "name": "Specs", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "specs#DiskIOPS" }, "remarks": "set \"replicationSpecs[n].regionConfigs[m].providerName\" : \"AWS\".\nset \"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M30\" or greater not including Mxx_NVME tiers.\nThe 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.\n\nInstance sizes M10 to M40 have a ratio of disk capacity to system memory of 60:1.\nInstance sizes greater than M40 have a ratio of 120:1.", "stability": "stable", "summary": "Target throughput desired for storage attached to your AWS-provisioned cluster. Only change this parameter if you:." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 750 }, "name": "diskIops", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "specs#EbsVolumeType" }, "remarks": "STANDARD volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size.\n\nPROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.\"", "stability": "stable", "summary": "Type of storage you want to attach to your AWS-provisioned cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 761 }, "name": "ebsVolumeType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "specs#InstanceSize" }, "remarks": "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.", "stability": "stable", "summary": "Hardware specification for the instance sizes in this region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 768 }, "name": "instanceSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "specs#NodeCount" }, "remarks": "Read-only nodes can never become the primary, but can enable local reads.", "stability": "stable", "summary": "Number of read-only nodes for MongoDB Cloud deploys to the region." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 775 }, "name": "nodeCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/cluster/index:Specs" }, "awscdk-resources-mongodbatlas.Storage": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Storage" }, "stability": "stable", "summary": "Configuration information for each data store and its mapping to MongoDB Cloud databases." }, "fqn": "awscdk-resources-mongodbatlas.Storage", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 203 }, "name": "Storage", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Storage#Databases" }, "stability": "stable", "summary": "Array that contains the queryable databases and collections for this data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 209 }, "name": "databases", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Database" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "Storage#Stores" }, "stability": "stable", "summary": "Array that contains the data stores for the data lake." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 216 }, "name": "stores", "optional": true, "type": { "collection": { "elementtype": { "fqn": "awscdk-resources-mongodbatlas.Store" }, "kind": "array" } } } ], "symbolId": "src/l1-resources/federated-database-instance/index:Storage" }, "awscdk-resources-mongodbatlas.Store": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Store" }, "stability": "stable", "summary": "Array that contains the data stores for the data lake." }, "fqn": "awscdk-resources-mongodbatlas.Store", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 303 }, "name": "Store", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Store#ClusterName" }, "stability": "stable", "summary": "Human-readable label of the MongoDB Cloud cluster on which the store is based." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 323 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Store#Name" }, "remarks": "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 data lake requires a serverless instance or an M10 or higher cluster.", "stability": "stable", "summary": "Human-readable label that identifies the data store." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 309 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Store#ProjectId" }, "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies the project.Regex ^([a-f0-9]{24})$ ." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 330 }, "name": "projectId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Store#Provider" }, "stability": "stable", "summary": "Allowed values atlas, http, online_archive, s3 and DataLakeAzureBlobStore." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 316 }, "name": "provider", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Store#ReadPreference" }, "stability": "stable", "summary": "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 337 }, "name": "readPreference", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.ReadPreference" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:Store" }, "awscdk-resources-mongodbatlas.StoreDetail": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StoreDetail" }, "stability": "stable", "summary": "Configuration information for each data store and its mapping to MongoDB Cloud databases." }, "fqn": "awscdk-resources-mongodbatlas.StoreDetail", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 384 }, "name": "StoreDetail", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#AdditionalStorageClasses" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 439 }, "name": "additionalStorageClasses", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Bucket" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 411 }, "name": "bucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Delimiter" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 425 }, "name": "delimiter", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#IncludeTags" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 432 }, "name": "includeTags", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the data store." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 390 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Prefix" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 418 }, "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Provider" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 397 }, "name": "provider", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StoreDetail#Region" }, "stability": "stable", "summary": "Human-readable label that identifies the Federated Database to update." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/datalakes/index.ts", "line": 404 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/datalakes/index:StoreDetail" }, "awscdk-resources-mongodbatlas.StreamConfig": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StreamConfig" }, "stability": "stable", "summary": "Configuration options for an Atlas Stream Processing Instance." }, "fqn": "awscdk-resources-mongodbatlas.StreamConfig", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 120 }, "name": "StreamConfig", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StreamConfig#Tier" }, "remarks": "Configures Memory / VCPU allowances.", "stability": "stable", "summary": "Selected tier for the Stream Instance." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 126 }, "name": "tier", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/stream-instance/index:StreamConfig" }, "awscdk-resources-mongodbatlas.StreamsConnection": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StreamsConnection" }, "stability": "stable", "summary": "Settings that define a connection to an external data store." }, "fqn": "awscdk-resources-mongodbatlas.StreamsConnection", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 155 }, "name": "StreamsConnection", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#Authentication" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 173 }, "name": "authentication", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaAuthentication" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#BootstrapServers" }, "stability": "stable", "summary": "Comma separated list of server addresses." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 180 }, "name": "bootstrapServers", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#ClusterName" }, "stability": "stable", "summary": "Name of the cluster configured for this connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 192 }, "name": "clusterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#DbRoleToExecute" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 197 }, "name": "dbRoleToExecute", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.DbRoleToExecute" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the stream connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 161 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#Security" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 185 }, "name": "security", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaSecurity" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsConnection#Type" }, "remarks": "Can be either Cluster or Kafka.", "stability": "stable", "summary": "Type of the connection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 168 }, "name": "type", "optional": true, "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsConnectionType" } } ], "symbolId": "src/l1-resources/stream-instance/index:StreamsConnection" }, "awscdk-resources-mongodbatlas.StreamsConnectionType": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "StreamsConnectionType" }, "remarks": "Can be either Cluster or Kafka.", "stability": "stable", "summary": "Type of the connection." }, "fqn": "awscdk-resources-mongodbatlas.StreamsConnectionType", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 250 }, "members": [ { "docs": { "stability": "stable", "summary": "Kafka." }, "name": "KAFKA" }, { "docs": { "stability": "stable", "summary": "Cluster." }, "name": "CLUSTER" }, { "docs": { "stability": "stable", "summary": "Sample." }, "name": "SAMPLE" } ], "name": "StreamsConnectionType", "symbolId": "src/l1-resources/stream-instance/index:StreamsConnectionType" }, "awscdk-resources-mongodbatlas.StreamsDataProcessRegion": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StreamsDataProcessRegion" }, "stability": "stable", "summary": "Information about the cloud provider region in which MongoDB Cloud processes the stream." }, "fqn": "awscdk-resources-mongodbatlas.StreamsDataProcessRegion", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 79 }, "name": "StreamsDataProcessRegion", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StreamsDataProcessRegion#CloudProvider" }, "remarks": "Currently, this parameter supports AWS only.", "stability": "stable", "summary": "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 85 }, "name": "cloudProvider", "type": { "fqn": "awscdk-resources-mongodbatlas.StreamsDataProcessRegionCloudProvider" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsDataProcessRegion#Region" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 90 }, "name": "region", "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/stream-instance/index:StreamsDataProcessRegion" }, "awscdk-resources-mongodbatlas.StreamsDataProcessRegionCloudProvider": { "assembly": "awscdk-resources-mongodbatlas", "docs": { "custom": { "schema": "StreamsDataProcessRegionCloudProvider" }, "remarks": "Currently, this parameter supports AWS only.", "stability": "stable", "summary": "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing." }, "fqn": "awscdk-resources-mongodbatlas.StreamsDataProcessRegionCloudProvider", "kind": "enum", "locationInModule": { "filename": "src/l1-resources/stream-instance/index.ts", "line": 232 }, "members": [ { "docs": { "stability": "stable", "summary": "AWS." }, "name": "AWS" }, { "docs": { "stability": "stable", "summary": "GCP." }, "name": "GCP" }, { "docs": { "stability": "stable", "summary": "AZURE." }, "name": "AZURE" }, { "docs": { "stability": "stable", "summary": "TENANT." }, "name": "TENANT" }, { "docs": { "stability": "stable", "summary": "SERVERLESS." }, "name": "SERVERLESS" } ], "name": "StreamsDataProcessRegionCloudProvider", "symbolId": "src/l1-resources/stream-instance/index:StreamsDataProcessRegionCloudProvider" }, "awscdk-resources-mongodbatlas.StreamsKafkaAuthentication": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StreamsKafkaAuthentication" }, "remarks": "Includes the authentication type, as well as the parameters for that authentication mode.", "stability": "stable", "summary": "User credentials required to connect to a Kafka Cluster." }, "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaAuthentication", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 176 }, "name": "StreamsKafkaAuthentication", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StreamsKafkaAuthentication#Mechanism" }, "remarks": "Can be one of PLAIN, SCRAM-256, or SCRAM-512.", "stability": "stable", "summary": "Style of authentication." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 182 }, "name": "mechanism", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsKafkaAuthentication#Password" }, "remarks": "Review [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials.", "stability": "stable", "summary": "Password of the account to connect to the Kafka cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 196 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsKafkaAuthentication#Username" }, "stability": "stable", "summary": "Username of the account to connect to the Kafka cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 189 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/stream-connection/index:StreamsKafkaAuthentication" }, "awscdk-resources-mongodbatlas.StreamsKafkaSecurity": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "StreamsKafkaSecurity" }, "remarks": "For SSL, this can include the trusted certificate to use.", "stability": "stable", "summary": "Properties for the secure transport connection to Kafka." }, "fqn": "awscdk-resources-mongodbatlas.StreamsKafkaSecurity", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 227 }, "name": "StreamsKafkaSecurity", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "StreamsKafkaSecurity#BrokerPublicCertificate" }, "stability": "stable", "summary": "A trusted, public x509 certificate for connecting to Kafka over SSL." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 233 }, "name": "brokerPublicCertificate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "StreamsKafkaSecurity#Protocol" }, "remarks": "Can be either PLAINTEXT or SSL.", "stability": "stable", "summary": "Describes the transport type." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/stream-connection/index.ts", "line": 240 }, "name": "protocol", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/stream-connection/index:StreamsKafkaSecurity" }, "awscdk-resources-mongodbatlas.SynchronousCreationOptions": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "SynchronousCreationOptions" }, "stability": "stable", "summary": "Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE." }, "fqn": "awscdk-resources-mongodbatlas.SynchronousCreationOptions", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 214 }, "name": "SynchronousCreationOptions", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "SynchronousCreationOptions#CallbackDelaySeconds" }, "remarks": "example: if set to 20, it will chek every 20 seconds if the resource is completed, default (30 seconds)", "stability": "stable", "summary": "Represents the time interval, measured in seconds, for the synchronous process to wait before checking again to verify if the job has been completed." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 227 }, "name": "callbackDelaySeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "schema": "SynchronousCreationOptions#ReturnSuccessIfTimeOut" }, "stability": "stable", "summary": "if set to true, the process will return success, in the event of a timeOut, default false." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 234 }, "name": "returnSuccessIfTimeOut", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "schema": "SynchronousCreationOptions#TimeOutInSeconds" }, "stability": "stable", "summary": "The amount of time the process will wait until exiting with a success, default (1200 seconds)." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cloud-backup-restore-jobs/index.ts", "line": 220 }, "name": "timeOutInSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/l1-resources/cloud-backup-restore-jobs/index:SynchronousCreationOptions" }, "awscdk-resources-mongodbatlas.SynonymSource": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "SynonymSource" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.SynonymSource", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 381 }, "name": "SynonymSource", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "SynonymSource#Collection" }, "stability": "stable", "summary": "Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/search-index/index.ts", "line": 387 }, "name": "collection", "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/search-index/index:SynonymSource" }, "awscdk-resources-mongodbatlas.Tag": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "tag" }, "stability": "stable", "summary": "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster." }, "fqn": "awscdk-resources-mongodbatlas.Tag", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 558 }, "name": "Tag", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "tag#Key" }, "remarks": "For example, environment in the environment : production tag.", "stability": "stable", "summary": "Constant that defines the set of the tag." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 564 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "tag#Value" }, "remarks": "For example, production in the environment : production tag.", "stability": "stable", "summary": "Variable that belongs to the set of the tag." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/cluster/index.ts", "line": 571 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/cluster/index:Tag" }, "awscdk-resources-mongodbatlas.TagSet": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "TagSet" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.TagSet", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 613 }, "name": "TagSet", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "TagSet#Name" }, "stability": "stable", "summary": "Human-readable label of the tag." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 619 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "TagSet#Value" }, "stability": "stable", "summary": "Human-readable label of the tag." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 626 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:TagSet" }, "awscdk-resources-mongodbatlas.ThirdPartyIntegrationProps": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ThirdPartyIntegrationProps", "kind": "interface", "locationInModule": { "filename": "src/l2-resources/third-party-integration/thirdPartyIntegrationBase.ts", "line": 14 }, "name": "ThirdPartyIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Unique 24-hexadecimal digit string that identifies your project." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/thirdPartyIntegrationBase.ts", "line": 18 }, "name": "projectId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Atlas API keys." }, "immutable": true, "locationInModule": { "filename": "src/l2-resources/third-party-integration/thirdPartyIntegrationBase.ts", "line": 23 }, "name": "profile", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l2-resources/third-party-integration/thirdPartyIntegrationBase:ThirdPartyIntegrationProps" }, "awscdk-resources-mongodbatlas.Transformations": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "transformations" }, "stability": "stable", "summary": "Ordered fields used to physically organize data in the destination." }, "fqn": "awscdk-resources-mongodbatlas.Transformations", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 215 }, "name": "Transformations", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "transformations#Field" }, "stability": "stable", "summary": "Key in the document." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 221 }, "name": "field", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "transformations#Type" }, "stability": "stable", "summary": "Type of transformation applied during the export of the namespace in a Data Lake Pipeline." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/data-lake-pipeline/index.ts", "line": 228 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/data-lake-pipeline/index:Transformations" }, "awscdk-resources-mongodbatlas.Validation": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "Validation" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.Validation", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 107 }, "name": "Validation", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "Validation#Status" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 111 }, "name": "status", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "Validation#ValidationType" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/ldap-verify/index.ts", "line": 116 }, "name": "validationType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/ldap-verify/index:Validation" }, "awscdk-resources-mongodbatlas.View": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "View" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.View", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 409 }, "name": "View", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "View#Name" }, "stability": "stable", "summary": "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 415 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "View#Pipeline" }, "stability": "stable", "summary": "Aggregation pipeline stages to apply to the source collection." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 422 }, "name": "pipeline", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "View#Source" }, "stability": "stable", "summary": "Human-readable label that identifies the source collection for the view." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/federated-database-instance/index.ts", "line": 429 }, "name": "source", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/federated-database-instance/index:View" }, "awscdk-resources-mongodbatlas.ZoneMapping": { "assembly": "awscdk-resources-mongodbatlas", "datatype": true, "docs": { "custom": { "schema": "zoneMapping" }, "stability": "stable" }, "fqn": "awscdk-resources-mongodbatlas.ZoneMapping", "kind": "interface", "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 148 }, "name": "ZoneMapping", "properties": [ { "abstract": true, "docs": { "custom": { "schema": "zoneMapping#Location" }, "remarks": "MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible.", "stability": "stable", "summary": "Code that represents a location that maps to a zone in your global cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 154 }, "name": "location", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "schema": "zoneMapping#Zone" }, "remarks": "This zone maps to a location code.", "stability": "stable", "summary": "Human-readable label that identifies the zone in your global cluster." }, "immutable": true, "locationInModule": { "filename": "src/l1-resources/global-cluster-config/index.ts", "line": 161 }, "name": "zone", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/l1-resources/global-cluster-config/index:ZoneMapping" } }, "version": "3.10.0", "fingerprint": "Vay2p4brgb4+OV+5BNBJE1Kk5qFZ4twoiNt5ndgih/8=" }