Skip to content

Latest commit

 

History

History
2172 lines (1348 loc) · 93.4 KB

searchIndex.typescript.md

File metadata and controls

2172 lines (1348 loc) · 93.4 KB

mongodbatlas_search_index

Refer to the Terraform Registory for docs: mongodbatlas_search_index.

searchIndex Submodule

Constructs

SearchIndex

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

Initializers 

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

new searchIndex.SearchIndex(scope: Construct, id: string, config: SearchIndexConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SearchIndexConfig 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.
putSynonyms No description.
putTimeouts No description.
resetAnalyzer No description.
resetAnalyzers No description.
resetId No description.
resetMappingsDynamic No description.
resetMappingsFields No description.
resetSearchAnalyzer No description.
resetStatus No description.
resetSynonyms No description.
resetTimeouts No description.
resetWaitForIndexBuildCompletion 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
putSynonyms 
public putSynonyms(value: IResolvable | SearchIndexSynonyms[]): void
valueRequired
putTimeouts 
public putTimeouts(value: SearchIndexTimeouts): void
valueRequired
resetAnalyzer 
public resetAnalyzer(): void
resetAnalyzers 
public resetAnalyzers(): void
resetId 
public resetId(): void
resetMappingsDynamic 
public resetMappingsDynamic(): void
resetMappingsFields 
public resetMappingsFields(): void
resetSearchAnalyzer 
public resetSearchAnalyzer(): void
resetStatus 
public resetStatus(): void
resetSynonyms 
public resetSynonyms(): void
resetTimeouts 
public resetTimeouts(): void
resetWaitForIndexBuildCompletion 
public resetWaitForIndexBuildCompletion(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { searchIndex } from '@cdktf/provider-mongodbatlas'

searchIndex.SearchIndex.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 { searchIndex } from '@cdktf/provider-mongodbatlas'

searchIndex.SearchIndex.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { searchIndex } from '@cdktf/provider-mongodbatlas'

searchIndex.SearchIndex.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.
indexId string No description.
synonyms SearchIndexSynonymsList No description.
timeouts SearchIndexTimeoutsOutputReference No description.
analyzerInput string No description.
analyzersInput string No description.
clusterNameInput string No description.
collectionNameInput string No description.
databaseInput string No description.
idInput string No description.
mappingsDynamicInput boolean | cdktf.IResolvable No description.
mappingsFieldsInput string No description.
nameInput string No description.
projectIdInput string No description.
searchAnalyzerInput string No description.
statusInput string No description.
synonymsInput cdktf.IResolvable | SearchIndexSynonyms[] No description.
timeoutsInput cdktf.IResolvable | SearchIndexTimeouts No description.
waitForIndexBuildCompletionInput boolean | cdktf.IResolvable No description.
analyzer string No description.
analyzers string No description.
clusterName string No description.
collectionName string No description.
database string No description.
id string No description.
mappingsDynamic boolean | cdktf.IResolvable No description.
mappingsFields string No description.
name string No description.
projectId string No description.
searchAnalyzer string No description.
status string No description.
waitForIndexBuildCompletion 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[]
indexIdRequired 
public readonly indexId: string;
  • Type: string
synonymsRequired 
public readonly synonyms: SearchIndexSynonymsList;
timeoutsRequired 
public readonly timeouts: SearchIndexTimeoutsOutputReference;
analyzerInputOptional 
public readonly analyzerInput: string;
  • Type: string
analyzersInputOptional 
public readonly analyzersInput: string;
  • Type: string
clusterNameInputOptional 
public readonly clusterNameInput: string;
  • Type: string
collectionNameInputOptional 
public readonly collectionNameInput: string;
  • Type: string
databaseInputOptional 
public readonly databaseInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
mappingsDynamicInputOptional 
public readonly mappingsDynamicInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
mappingsFieldsInputOptional 
public readonly mappingsFieldsInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
projectIdInputOptional 
public readonly projectIdInput: string;
  • Type: string
searchAnalyzerInputOptional 
public readonly searchAnalyzerInput: string;
  • Type: string
statusInputOptional 
public readonly statusInput: string;
  • Type: string
synonymsInputOptional 
public readonly synonymsInput: IResolvable | SearchIndexSynonyms[];
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | SearchIndexTimeouts;
waitForIndexBuildCompletionInputOptional 
public readonly waitForIndexBuildCompletionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
analyzerRequired 
public readonly analyzer: string;
  • Type: string
analyzersRequired 
public readonly analyzers: string;
  • Type: string
clusterNameRequired 
public readonly clusterName: string;
  • Type: string
collectionNameRequired 
public readonly collectionName: string;
  • Type: string
databaseRequired 
public readonly database: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
mappingsDynamicRequired 
public readonly mappingsDynamic: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
mappingsFieldsRequired 
public readonly mappingsFields: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
projectIdRequired 
public readonly projectId: string;
  • Type: string
searchAnalyzerRequired 
public readonly searchAnalyzer: string;
  • Type: string
statusRequired 
public readonly status: string;
  • Type: string
waitForIndexBuildCompletionRequired 
public readonly waitForIndexBuildCompletion: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

SearchIndexConfig

Initializer 

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

const searchIndexConfig: searchIndex.SearchIndexConfig = { ... }

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.
clusterName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#cluster_name SearchIndex#cluster_name}.
collectionName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#collection_name SearchIndex#collection_name}.
database string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#database SearchIndex#database}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#name SearchIndex#name}.
projectId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#project_id SearchIndex#project_id}.
analyzer string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzer SearchIndex#analyzer}.
analyzers string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzers SearchIndex#analyzers}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#id SearchIndex#id}.
mappingsDynamic boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#mappings_dynamic SearchIndex#mappings_dynamic}.
mappingsFields string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#mappings_fields SearchIndex#mappings_fields}.
searchAnalyzer string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#search_analyzer SearchIndex#search_analyzer}.
status string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#status SearchIndex#status}.
synonyms cdktf.IResolvable | SearchIndexSynonyms[] synonyms block.
timeouts SearchIndexTimeouts timeouts block.
waitForIndexBuildCompletion boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#wait_for_index_build_completion SearchIndex#wait_for_index_build_completion}.
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[]
clusterNameRequired 
public readonly clusterName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#cluster_name SearchIndex#cluster_name}.

collectionNameRequired 
public readonly collectionName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#collection_name SearchIndex#collection_name}.

databaseRequired 
public readonly database: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#database SearchIndex#database}.

nameRequired 
public readonly name: string;
  • Type: string

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

projectIdRequired 
public readonly projectId: string;
  • Type: string

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

analyzerOptional 
public readonly analyzer: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzer SearchIndex#analyzer}.

analyzersOptional 
public readonly analyzers: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzers SearchIndex#analyzers}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#id SearchIndex#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.

mappingsDynamicOptional 
public readonly mappingsDynamic: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#mappings_dynamic SearchIndex#mappings_dynamic}.

mappingsFieldsOptional 
public readonly mappingsFields: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#mappings_fields SearchIndex#mappings_fields}.

searchAnalyzerOptional 
public readonly searchAnalyzer: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#search_analyzer SearchIndex#search_analyzer}.

statusOptional 
public readonly status: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#status SearchIndex#status}.

synonymsOptional 
public readonly synonyms: IResolvable | SearchIndexSynonyms[];

synonyms block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#synonyms SearchIndex#synonyms}

timeoutsOptional 
public readonly timeouts: SearchIndexTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#timeouts SearchIndex#timeouts}

waitForIndexBuildCompletionOptional 
public readonly waitForIndexBuildCompletion: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#wait_for_index_build_completion SearchIndex#wait_for_index_build_completion}.

SearchIndexSynonyms

Initializer 

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

const searchIndexSynonyms: searchIndex.SearchIndexSynonyms = { ... }

Properties

Name Type Description
analyzer string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzer SearchIndex#analyzer}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#name SearchIndex#name}.
sourceCollection string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#source_collection SearchIndex#source_collection}.
analyzerRequired 
public readonly analyzer: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#analyzer SearchIndex#analyzer}.

nameRequired 
public readonly name: string;
  • Type: string

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

sourceCollectionRequired 
public readonly sourceCollection: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#source_collection SearchIndex#source_collection}.

SearchIndexTimeouts

Initializer 

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

const searchIndexTimeouts: searchIndex.SearchIndexTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#create SearchIndex#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#delete SearchIndex#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#update SearchIndex#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#create SearchIndex#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#delete SearchIndex#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/resources/search_index#update SearchIndex#update}.

Classes

SearchIndexSynonymsList

Initializers 

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

new searchIndex.SearchIndexSynonymsList(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): SearchIndexSynonymsOutputReference
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 | SearchIndexSynonyms[] 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 | SearchIndexSynonyms[];

SearchIndexSynonymsOutputReference

Initializers 

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

new searchIndex.SearchIndexSynonymsOutputReference(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.
analyzerInput string No description.
nameInput string No description.
sourceCollectionInput string No description.
analyzer string No description.
name string No description.
sourceCollection string No description.
internalValue cdktf.IResolvable | SearchIndexSynonyms 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
analyzerInputOptional 
public readonly analyzerInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
sourceCollectionInputOptional 
public readonly sourceCollectionInput: string;
  • Type: string
analyzerRequired 
public readonly analyzer: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
sourceCollectionRequired 
public readonly sourceCollection: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | SearchIndexSynonyms;

SearchIndexTimeoutsOutputReference

Initializers 

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

new searchIndex.SearchIndexTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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.
resetCreate No description.
resetDelete No description.
resetUpdate No description.
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.

resetCreate 
public resetCreate(): void
resetDelete 
public resetDelete(): void
resetUpdate 
public resetUpdate(): void

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.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | SearchIndexTimeouts 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
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | SearchIndexTimeouts;