Skip to content

Latest commit

 

History

History
2231 lines (1378 loc) · 94.8 KB

project.typescript.md

File metadata and controls

2231 lines (1378 loc) · 94.8 KB

mongodbatlas_project

Refer to the Terraform Registory for docs: mongodbatlas_project.

project Submodule

Constructs

Project

Represents a {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project mongodbatlas_project}.

Initializers

import { project } from '@cdktf/provider-mongodbatlas'

new project.Project(scope: Construct, id: string, config: ProjectConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ProjectConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putLimits No description.
putTeams No description.
resetIsCollectDatabaseSpecificsStatisticsEnabled No description.
resetIsDataExplorerEnabled No description.
resetIsExtendedStorageSizesEnabled No description.
resetIsPerformanceAdvisorEnabled No description.
resetIsRealtimePerformancePanelEnabled No description.
resetIsSchemaAdvisorEnabled No description.
resetLimits No description.
resetProjectOwnerId No description.
resetRegionUsageRestrictions No description.
resetTeams No description.
resetWithDefaultAlertsSettings No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

putLimits
public putLimits(value: IResolvable | ProjectLimits[]): void
valueRequired

putTeams
public putTeams(value: IResolvable | ProjectTeams[]): void
valueRequired

resetIsCollectDatabaseSpecificsStatisticsEnabled
public resetIsCollectDatabaseSpecificsStatisticsEnabled(): void
resetIsDataExplorerEnabled
public resetIsDataExplorerEnabled(): void
resetIsExtendedStorageSizesEnabled
public resetIsExtendedStorageSizesEnabled(): void
resetIsPerformanceAdvisorEnabled
public resetIsPerformanceAdvisorEnabled(): void
resetIsRealtimePerformancePanelEnabled
public resetIsRealtimePerformancePanelEnabled(): void
resetIsSchemaAdvisorEnabled
public resetIsSchemaAdvisorEnabled(): void
resetLimits
public resetLimits(): void
resetProjectOwnerId
public resetProjectOwnerId(): void
resetRegionUsageRestrictions
public resetRegionUsageRestrictions(): void
resetTeams
public resetTeams(): void
resetWithDefaultAlertsSettings
public resetWithDefaultAlertsSettings(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.

isConstruct
import { project } from '@cdktf/provider-mongodbatlas'

project.Project.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.


isTerraformElement
import { project } from '@cdktf/provider-mongodbatlas'

project.Project.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { project } from '@cdktf/provider-mongodbatlas'

project.Project.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
clusterCount number No description.
created string No description.
id string No description.
limits ProjectLimitsList No description.
teams ProjectTeamsList No description.
isCollectDatabaseSpecificsStatisticsEnabledInput boolean | cdktf.IResolvable No description.
isDataExplorerEnabledInput boolean | cdktf.IResolvable No description.
isExtendedStorageSizesEnabledInput boolean | cdktf.IResolvable No description.
isPerformanceAdvisorEnabledInput boolean | cdktf.IResolvable No description.
isRealtimePerformancePanelEnabledInput boolean | cdktf.IResolvable No description.
isSchemaAdvisorEnabledInput boolean | cdktf.IResolvable No description.
limitsInput cdktf.IResolvable | ProjectLimits[] No description.
nameInput string No description.
orgIdInput string No description.
projectOwnerIdInput string No description.
regionUsageRestrictionsInput string No description.
teamsInput cdktf.IResolvable | ProjectTeams[] No description.
withDefaultAlertsSettingsInput boolean | cdktf.IResolvable No description.
isCollectDatabaseSpecificsStatisticsEnabled boolean | cdktf.IResolvable No description.
isDataExplorerEnabled boolean | cdktf.IResolvable No description.
isExtendedStorageSizesEnabled boolean | cdktf.IResolvable No description.
isPerformanceAdvisorEnabled boolean | cdktf.IResolvable No description.
isRealtimePerformancePanelEnabled boolean | cdktf.IResolvable No description.
isSchemaAdvisorEnabled boolean | cdktf.IResolvable No description.
name string No description.
orgId string No description.
projectOwnerId string No description.
regionUsageRestrictions string No description.
withDefaultAlertsSettings boolean | cdktf.IResolvable No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

clusterCountRequired
public readonly clusterCount: number;
  • Type: number

createdRequired
public readonly created: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

limitsRequired
public readonly limits: ProjectLimitsList;

teamsRequired
public readonly teams: ProjectTeamsList;

isCollectDatabaseSpecificsStatisticsEnabledInputOptional
public readonly isCollectDatabaseSpecificsStatisticsEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isDataExplorerEnabledInputOptional
public readonly isDataExplorerEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isExtendedStorageSizesEnabledInputOptional
public readonly isExtendedStorageSizesEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isPerformanceAdvisorEnabledInputOptional
public readonly isPerformanceAdvisorEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isRealtimePerformancePanelEnabledInputOptional
public readonly isRealtimePerformancePanelEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isSchemaAdvisorEnabledInputOptional
public readonly isSchemaAdvisorEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

limitsInputOptional
public readonly limitsInput: IResolvable | ProjectLimits[];

nameInputOptional
public readonly nameInput: string;
  • Type: string

orgIdInputOptional
public readonly orgIdInput: string;
  • Type: string

projectOwnerIdInputOptional
public readonly projectOwnerIdInput: string;
  • Type: string

regionUsageRestrictionsInputOptional
public readonly regionUsageRestrictionsInput: string;
  • Type: string

teamsInputOptional
public readonly teamsInput: IResolvable | ProjectTeams[];

withDefaultAlertsSettingsInputOptional
public readonly withDefaultAlertsSettingsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isCollectDatabaseSpecificsStatisticsEnabledRequired
public readonly isCollectDatabaseSpecificsStatisticsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isDataExplorerEnabledRequired
public readonly isDataExplorerEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isExtendedStorageSizesEnabledRequired
public readonly isExtendedStorageSizesEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isPerformanceAdvisorEnabledRequired
public readonly isPerformanceAdvisorEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isRealtimePerformancePanelEnabledRequired
public readonly isRealtimePerformancePanelEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

isSchemaAdvisorEnabledRequired
public readonly isSchemaAdvisorEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

nameRequired
public readonly name: string;
  • Type: string

orgIdRequired
public readonly orgId: string;
  • Type: string

projectOwnerIdRequired
public readonly projectOwnerId: string;
  • Type: string

regionUsageRestrictionsRequired
public readonly regionUsageRestrictions: string;
  • Type: string

withDefaultAlertsSettingsRequired
public readonly withDefaultAlertsSettings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

ProjectConfig

Initializer

import { project } from '@cdktf/provider-mongodbatlas'

const projectConfig: project.ProjectConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#name Project#name}.
orgId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#org_id Project#org_id}.
isCollectDatabaseSpecificsStatisticsEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_collect_database_specifics_statistics_enabled Project#is_collect_database_specifics_statistics_enabled}.
isDataExplorerEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_data_explorer_enabled Project#is_data_explorer_enabled}.
isExtendedStorageSizesEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_extended_storage_sizes_enabled Project#is_extended_storage_sizes_enabled}.
isPerformanceAdvisorEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_performance_advisor_enabled Project#is_performance_advisor_enabled}.
isRealtimePerformancePanelEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_realtime_performance_panel_enabled Project#is_realtime_performance_panel_enabled}.
isSchemaAdvisorEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_schema_advisor_enabled Project#is_schema_advisor_enabled}.
limits cdktf.IResolvable | ProjectLimits[] limits block.
projectOwnerId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#project_owner_id Project#project_owner_id}.
regionUsageRestrictions string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#region_usage_restrictions Project#region_usage_restrictions}.
teams cdktf.IResolvable | ProjectTeams[] teams block.
withDefaultAlertsSettings boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#with_default_alerts_settings Project#with_default_alerts_settings}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#name Project#name}.


orgIdRequired
public readonly orgId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#org_id Project#org_id}.


isCollectDatabaseSpecificsStatisticsEnabledOptional
public readonly isCollectDatabaseSpecificsStatisticsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_collect_database_specifics_statistics_enabled Project#is_collect_database_specifics_statistics_enabled}.


isDataExplorerEnabledOptional
public readonly isDataExplorerEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_data_explorer_enabled Project#is_data_explorer_enabled}.


isExtendedStorageSizesEnabledOptional
public readonly isExtendedStorageSizesEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_extended_storage_sizes_enabled Project#is_extended_storage_sizes_enabled}.


isPerformanceAdvisorEnabledOptional
public readonly isPerformanceAdvisorEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_performance_advisor_enabled Project#is_performance_advisor_enabled}.


isRealtimePerformancePanelEnabledOptional
public readonly isRealtimePerformancePanelEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_realtime_performance_panel_enabled Project#is_realtime_performance_panel_enabled}.


isSchemaAdvisorEnabledOptional
public readonly isSchemaAdvisorEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#is_schema_advisor_enabled Project#is_schema_advisor_enabled}.


limitsOptional
public readonly limits: IResolvable | ProjectLimits[];

limits block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#limits Project#limits}


projectOwnerIdOptional
public readonly projectOwnerId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#project_owner_id Project#project_owner_id}.


regionUsageRestrictionsOptional
public readonly regionUsageRestrictions: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#region_usage_restrictions Project#region_usage_restrictions}.


teamsOptional
public readonly teams: IResolvable | ProjectTeams[];

teams block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#teams Project#teams}


withDefaultAlertsSettingsOptional
public readonly withDefaultAlertsSettings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#with_default_alerts_settings Project#with_default_alerts_settings}.


ProjectLimits

Initializer

import { project } from '@cdktf/provider-mongodbatlas'

const projectLimits: project.ProjectLimits = { ... }

Properties

Name Type Description
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#name Project#name}.
value number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#value Project#value}.

nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#name Project#name}.


valueRequired
public readonly value: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#value Project#value}.


ProjectTeams

Initializer

import { project } from '@cdktf/provider-mongodbatlas'

const projectTeams: project.ProjectTeams = { ... }

Properties

Name Type Description
roleNames string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#role_names Project#role_names}.
teamId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#team_id Project#team_id}.

roleNamesRequired
public readonly roleNames: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#role_names Project#role_names}.


teamIdRequired
public readonly teamId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/project#team_id Project#team_id}.


Classes

ProjectLimitsList

Initializers

import { project } from '@cdktf/provider-mongodbatlas'

new project.ProjectLimitsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): ProjectLimitsOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ProjectLimits[] No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | ProjectLimits[];

ProjectLimitsOutputReference

Initializers

import { project } from '@cdktf/provider-mongodbatlas'

new project.ProjectLimitsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
currentUsage number No description.
defaultLimit number No description.
maximumLimit number No description.
nameInput string No description.
valueInput number No description.
name string No description.
value number No description.
internalValue cdktf.IResolvable | ProjectLimits No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

currentUsageRequired
public readonly currentUsage: number;
  • Type: number

defaultLimitRequired
public readonly defaultLimit: number;
  • Type: number

maximumLimitRequired
public readonly maximumLimit: number;
  • Type: number

nameInputOptional
public readonly nameInput: string;
  • Type: string

valueInputOptional
public readonly valueInput: number;
  • Type: number

nameRequired
public readonly name: string;
  • Type: string

valueRequired
public readonly value: number;
  • Type: number

internalValueOptional
public readonly internalValue: IResolvable | ProjectLimits;

ProjectTeamsList

Initializers

import { project } from '@cdktf/provider-mongodbatlas'

new project.ProjectTeamsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): ProjectTeamsOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ProjectTeams[] No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | ProjectTeams[];

ProjectTeamsOutputReference

Initializers

import { project } from '@cdktf/provider-mongodbatlas'

new project.ProjectTeamsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
roleNamesInput string[] No description.
teamIdInput string No description.
roleNames string[] No description.
teamId string No description.
internalValue cdktf.IResolvable | ProjectTeams No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

roleNamesInputOptional
public readonly roleNamesInput: string[];
  • Type: string[]

teamIdInputOptional
public readonly teamIdInput: string;
  • Type: string

roleNamesRequired
public readonly roleNames: string[];
  • Type: string[]

teamIdRequired
public readonly teamId: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | ProjectTeams;