Skip to content

Commit 3a465a9

Browse files
authored
feat: intmdb 954 phase 2 project updates (#115)
1 parent 2c045ab commit 3a465a9

File tree

2 files changed

+82
-11
lines changed

2 files changed

+82
-11
lines changed

API.md

Lines changed: 52 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/l1-resources/project/index.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,15 @@ export interface CfnProjectProps {
4242
readonly profile?: string;
4343

4444
/**
45+
* Teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier.
46+
*
4547
* @schema CfnProjectProps#ProjectTeams
4648
*/
4749
readonly projectTeams?: ProjectTeam[];
4850

4951
/**
52+
* API keys that you assigned to the specified project.
53+
*
5054
* @schema CfnProjectProps#ProjectApiKeys
5155
*/
5256
readonly projectApiKeys?: ProjectApiKey[];
@@ -84,26 +88,43 @@ export function toJson_CfnProjectProps(
8488
*/
8589
export interface ProjectSettings {
8690
/**
91+
* Flag that indicates whether to collect database-specific metrics for the specified project.
92+
*
8793
* @schema projectSettings#IsCollectDatabaseSpecificsStatisticsEnabled
8894
*/
8995
readonly isCollectDatabaseSpecificsStatisticsEnabled?: boolean;
9096

9197
/**
98+
* Flag that indicates whether to enable the Data Explorer for the specified project.
99+
*
92100
* @schema projectSettings#IsDataExplorerEnabled
93101
*/
94102
readonly isDataExplorerEnabled?: boolean;
95103

96104
/**
105+
* Flag that indicates whether to enable extended storage sizes for the specified project.
106+
*
107+
* @schema projectSettings#IsExtendedStorageSizesEnabled
108+
*/
109+
readonly isExtendedStorageSizesEnabled?: boolean;
110+
111+
/**
112+
* Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.
113+
*
97114
* @schema projectSettings#IsPerformanceAdvisorEnabled
98115
*/
99116
readonly isPerformanceAdvisorEnabled?: boolean;
100117

101118
/**
119+
* Flag that indicates whether to enable the Real Time Performance Panel for the specified project.
120+
*
102121
* @schema projectSettings#IsRealtimePerformancePanelEnabled
103122
*/
104123
readonly isRealtimePerformancePanelEnabled?: boolean;
105124

106125
/**
126+
* Flag that indicates whether to enable the Schema Advisor for the specified project.
127+
*
107128
* @schema projectSettings#IsSchemaAdvisorEnabled
108129
*/
109130
readonly isSchemaAdvisorEnabled?: boolean;
@@ -123,6 +144,7 @@ export function toJson_ProjectSettings(
123144
IsCollectDatabaseSpecificsStatisticsEnabled:
124145
obj.isCollectDatabaseSpecificsStatisticsEnabled,
125146
IsDataExplorerEnabled: obj.isDataExplorerEnabled,
147+
IsExtendedStorageSizesEnabled: obj.isExtendedStorageSizesEnabled,
126148
IsPerformanceAdvisorEnabled: obj.isPerformanceAdvisorEnabled,
127149
IsRealtimePerformancePanelEnabled: obj.isRealtimePerformancePanelEnabled,
128150
IsSchemaAdvisorEnabled: obj.isSchemaAdvisorEnabled,
@@ -140,11 +162,15 @@ export function toJson_ProjectSettings(
140162
*/
141163
export interface ProjectTeam {
142164
/**
165+
* Unique 24-hexadecimal character string that identifies the team. string = 24 characters ^([a-f0-9]{24})$
166+
*
143167
* @schema projectTeam#TeamId
144168
*/
145169
readonly teamId?: string;
146170

147171
/**
172+
* One or more organization- or project-level roles to assign to the MongoDB Cloud user. tems Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"
173+
*
148174
* @schema projectTeam#RoleNames
149175
*/
150176
readonly roleNames?: string[];
@@ -177,11 +203,15 @@ export function toJson_ProjectTeam(
177203
*/
178204
export interface ProjectApiKey {
179205
/**
206+
* Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.
207+
*
180208
* @schema projectApiKey#Key
181209
*/
182210
readonly key?: string;
183211

184212
/**
213+
* List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR"
214+
*
185215
* @schema projectApiKey#RoleNames
186216
*/
187217
readonly roleNames?: string[];

0 commit comments

Comments
 (0)