maintenanceWindow.typescript.md

mongodbatlas_maintenance_window

Refer to the Terraform Registory for docs: mongodbatlas_maintenance_window.

maintenanceWindow Submodule

Constructs

MaintenanceWindow

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

Initializers

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

new maintenanceWindow.MaintenanceWindow(scope: Construct, id: string, config: MaintenanceWindowConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	MaintenanceWindowConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: MaintenanceWindowConfig

---

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.
resetAutoDefer	No description.
resetAutoDeferOnceEnabled	No description.
resetDayOfWeek	No description.
resetDefer	No description.
resetHourOfDay	No description.
resetId	No description.
resetNumberOfDeferrals	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

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}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetAutoDefer

public resetAutoDefer(): void

resetAutoDeferOnceEnabled

public resetAutoDeferOnceEnabled(): void

resetDayOfWeek

public resetDayOfWeek(): void

resetDefer

public resetDefer(): void

resetHourOfDay

public resetHourOfDay(): void

resetId

public resetId(): void

resetNumberOfDeferrals

public resetNumberOfDeferrals(): void

Static Functions

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

---

isConstruct

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

maintenanceWindow.MaintenanceWindow.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

maintenanceWindow.MaintenanceWindow.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

maintenanceWindow.MaintenanceWindow.isTerraformResource(x: any)

x^Required

• 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.
startAsap	cdktf.IResolvable	No description.
autoDeferInput	boolean | cdktf.IResolvable	No description.
autoDeferOnceEnabledInput	boolean | cdktf.IResolvable	No description.
dayOfWeekInput	number	No description.
deferInput	boolean | cdktf.IResolvable	No description.
hourOfDayInput	number	No description.
idInput	string	No description.
numberOfDeferralsInput	number	No description.
projectIdInput	string	No description.
autoDefer	boolean | cdktf.IResolvable	No description.
autoDeferOnceEnabled	boolean | cdktf.IResolvable	No description.
dayOfWeek	number	No description.
defer	boolean | cdktf.IResolvable	No description.
hourOfDay	number	No description.
id	string	No description.
numberOfDeferrals	number	No description.
projectId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

startAsap^Required

public readonly startAsap: IResolvable;

• Type: cdktf.IResolvable

---

autoDeferInput^Optional

public readonly autoDeferInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

autoDeferOnceEnabledInput^Optional

public readonly autoDeferOnceEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

dayOfWeekInput^Optional

public readonly dayOfWeekInput: number;

• Type: number

---

deferInput^Optional

public readonly deferInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

hourOfDayInput^Optional

public readonly hourOfDayInput: number;

• Type: number

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

numberOfDeferralsInput^Optional

public readonly numberOfDeferralsInput: number;

• Type: number

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

autoDefer^Required

public readonly autoDefer: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

autoDeferOnceEnabled^Required

public readonly autoDeferOnceEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

dayOfWeek^Required

public readonly dayOfWeek: number;

• Type: number

---

defer^Required

public readonly defer: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

hourOfDay^Required

public readonly hourOfDay: number;

• Type: number

---

id^Required

public readonly id: string;

• Type: string

---

numberOfDeferrals^Required

public readonly numberOfDeferrals: number;

• Type: number

---

projectId^Required

public readonly projectId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

MaintenanceWindowConfig

Initializer

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

const maintenanceWindowConfig: maintenanceWindow.MaintenanceWindowConfig = { ... }

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.
projectId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#project_id MaintenanceWindow#project_id}.
autoDefer	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#auto_defer MaintenanceWindow#auto_defer}.
autoDeferOnceEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#auto_defer_once_enabled MaintenanceWindow#auto_defer_once_enabled}.
dayOfWeek	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#day_of_week MaintenanceWindow#day_of_week}.
defer	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#defer MaintenanceWindow#defer}.
hourOfDay	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#hour_of_day MaintenanceWindow#hour_of_day}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#id MaintenanceWindow#id}.
numberOfDeferrals	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#number_of_deferrals MaintenanceWindow#number_of_deferrals}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

projectId^Required

public readonly projectId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#project_id MaintenanceWindow#project_id}.

---

autoDefer^Optional

public readonly autoDefer: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#auto_defer MaintenanceWindow#auto_defer}.

---

autoDeferOnceEnabled^Optional

public readonly autoDeferOnceEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#auto_defer_once_enabled MaintenanceWindow#auto_defer_once_enabled}.

---

dayOfWeek^Optional

public readonly dayOfWeek: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#day_of_week MaintenanceWindow#day_of_week}.

---

defer^Optional

public readonly defer: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#defer MaintenanceWindow#defer}.

---

hourOfDay^Optional

public readonly hourOfDay: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#hour_of_day MaintenanceWindow#hour_of_day}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#id MaintenanceWindow#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

numberOfDeferrals^Optional

public readonly numberOfDeferrals: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/maintenance_window#number_of_deferrals MaintenanceWindow#number_of_deferrals}.

---