Skip to content

Latest commit

 

History

History
1885 lines (1157 loc) · 93.2 KB

dataMongodbatlasSearchIndexes.typescript.md

File metadata and controls

1885 lines (1157 loc) · 93.2 KB

data_mongodbatlas_search_indexes

Refer to the Terraform Registory for docs: data_mongodbatlas_search_indexes.

dataMongodbatlasSearchIndexes Submodule

Constructs

DataMongodbatlasSearchIndexes

Represents a {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes mongodbatlas_search_indexes}.

Initializers 

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

new dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexes(scope: Construct, id: string, config: DataMongodbatlasSearchIndexesConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataMongodbatlasSearchIndexesConfig 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.
resetId No description.
resetItemsPerPage No description.
resetPageNum 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
resetId 
public resetId(): void
resetItemsPerPage 
public resetItemsPerPage(): void
resetPageNum 
public resetPageNum(): void

Static Functions

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

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

dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexes.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformDataSource 
import { dataMongodbatlasSearchIndexes } from '@cdktf/provider-mongodbatlas'

dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexes.isTerraformDataSource(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.
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.
results DataMongodbatlasSearchIndexesResultsList No description.
totalCount number No description.
clusterNameInput string No description.
collectionNameInput string No description.
databaseInput string No description.
idInput string No description.
itemsPerPageInput number No description.
pageNumInput number No description.
projectIdInput string No description.
clusterName string No description.
collectionName string No description.
database string No description.
id string No description.
itemsPerPage number No description.
pageNum number No description.
projectId string 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
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
resultsRequired 
public readonly results: DataMongodbatlasSearchIndexesResultsList;
totalCountRequired 
public readonly totalCount: number;
  • Type: number
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
itemsPerPageInputOptional 
public readonly itemsPerPageInput: number;
  • Type: number
pageNumInputOptional 
public readonly pageNumInput: number;
  • Type: number
projectIdInputOptional 
public readonly projectIdInput: 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
itemsPerPageRequired 
public readonly itemsPerPage: number;
  • Type: number
pageNumRequired 
public readonly pageNum: number;
  • Type: number
projectIdRequired 
public readonly projectId: string;
  • Type: string

Constants

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

Structs

DataMongodbatlasSearchIndexesConfig

Initializer 

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

const dataMongodbatlasSearchIndexesConfig: dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesConfig = { ... }

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/data-sources/search_indexes#cluster_name DataMongodbatlasSearchIndexes#cluster_name}.
collectionName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#collection_name DataMongodbatlasSearchIndexes#collection_name}.
database string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#database DataMongodbatlasSearchIndexes#database}.
projectId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#project_id DataMongodbatlasSearchIndexes#project_id}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#id DataMongodbatlasSearchIndexes#id}.
itemsPerPage number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#items_per_page DataMongodbatlasSearchIndexes#items_per_page}.
pageNum number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#page_num DataMongodbatlasSearchIndexes#page_num}.
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/data-sources/search_indexes#cluster_name DataMongodbatlasSearchIndexes#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/data-sources/search_indexes#collection_name DataMongodbatlasSearchIndexes#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/data-sources/search_indexes#database DataMongodbatlasSearchIndexes#database}.

projectIdRequired 
public readonly projectId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#project_id DataMongodbatlasSearchIndexes#project_id}.

idOptional 
public readonly id: string;
  • Type: string

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

itemsPerPageOptional 
public readonly itemsPerPage: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#items_per_page DataMongodbatlasSearchIndexes#items_per_page}.

pageNumOptional 
public readonly pageNum: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.12.1/docs/data-sources/search_indexes#page_num DataMongodbatlasSearchIndexes#page_num}.

DataMongodbatlasSearchIndexesResults

Initializer 

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

const dataMongodbatlasSearchIndexesResults: dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResults = { ... }

DataMongodbatlasSearchIndexesResultsSynonyms

Initializer 

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

const dataMongodbatlasSearchIndexesResultsSynonyms: dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResultsSynonyms = { ... }

Classes

DataMongodbatlasSearchIndexesResultsList

Initializers 

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

new dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResultsList(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): DataMongodbatlasSearchIndexesResultsOutputReference
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.
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

DataMongodbatlasSearchIndexesResultsOutputReference

Initializers 

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

new dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResultsOutputReference(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.
analyzer string No description.
analyzers string No description.
clusterName string No description.
collectionName string No description.
database string No description.
indexId string No description.
mappingsDynamic cdktf.IResolvable No description.
mappingsFields string No description.
name string No description.
projectId string No description.
searchAnalyzer string No description.
status string No description.
synonyms DataMongodbatlasSearchIndexesResultsSynonymsList No description.
waitForIndexBuildCompletion cdktf.IResolvable No description.
internalValue DataMongodbatlasSearchIndexesResults 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
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
indexIdRequired 
public readonly indexId: string;
  • Type: string
mappingsDynamicRequired 
public readonly mappingsDynamic: IResolvable;
  • Type: 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
synonymsRequired 
public readonly synonyms: DataMongodbatlasSearchIndexesResultsSynonymsList;
waitForIndexBuildCompletionRequired 
public readonly waitForIndexBuildCompletion: IResolvable;
  • Type: cdktf.IResolvable
internalValueOptional 
public readonly internalValue: DataMongodbatlasSearchIndexesResults;

DataMongodbatlasSearchIndexesResultsSynonymsList

Initializers 

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

new dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResultsSynonymsList(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): DataMongodbatlasSearchIndexesResultsSynonymsOutputReference
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.
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

DataMongodbatlasSearchIndexesResultsSynonymsOutputReference

Initializers 

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

new dataMongodbatlasSearchIndexes.DataMongodbatlasSearchIndexesResultsSynonymsOutputReference(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.
analyzer string No description.
name string No description.
sourceCollection string No description.
internalValue DataMongodbatlasSearchIndexesResultsSynonyms 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
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: DataMongodbatlasSearchIndexesResultsSynonyms;