`firestoreField` Submodule

Constructs

FirestoreField

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field google_firestore_field}.

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreField(scope Construct, id *string, config FirestoreFieldConfig) FirestoreField

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`FirestoreFieldConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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: FirestoreFieldConfig

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.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`AddMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`HasResourceMove`	No description.
`ImportFrom`	No description.
`InterpolationForAttribute`	No description.
`MoveFromId`	Move the resource corresponding to "id" to this resource.
`MoveTo`	Moves this resource to the target resource given by moveTarget.
`MoveToId`	Moves this resource to the resource corresponding to "id".
`PutIndexConfig`	No description.
`PutTimeouts`	No description.
`PutTtlConfig`	No description.
`ResetDatabase`	No description.
`ResetId`	No description.
`ResetIndexConfig`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.
`ResetTtlConfig`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

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`

func ResetOverrideLogicalId()

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

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`AddMoveTarget`

func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: *string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`MoveFromId`

func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`MoveTo`

func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`MoveToId`

func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`PutIndexConfig`

func PutIndexConfig(value FirestoreFieldIndexConfig)

`value`^Required

Type: FirestoreFieldIndexConfig

`PutTimeouts`

func PutTimeouts(value FirestoreFieldTimeouts)

`value`^Required

Type: FirestoreFieldTimeouts

`PutTtlConfig`

func PutTtlConfig(value FirestoreFieldTtlConfig)

`value`^Required

Type: FirestoreFieldTtlConfig

`ResetDatabase`

func ResetDatabase()

`ResetId`

func ResetId()

`ResetIndexConfig`

func ResetIndexConfig()

`ResetProject`

func ResetProject()

`ResetTimeouts`

func ResetTimeouts()

`ResetTtlConfig`

func ResetTtlConfig()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a FirestoreField resource upon running "cdktf plan ".

`IsConstruct`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.FirestoreField_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.FirestoreField_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.FirestoreField_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.FirestoreField_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a FirestoreField resource upon running "cdktf plan ".

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`importToId`^Required

Type: *string

The construct id used in the generated config for the FirestoreField to import.

`importFromId`^Required

Type: *string

The id of the existing FirestoreField that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the FirestoreField to import is found.

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`IndexConfig`	`FirestoreFieldIndexConfigOutputReference`	No description.
`Name`	`*string`	No description.
`Timeouts`	`FirestoreFieldTimeoutsOutputReference`	No description.
`TtlConfig`	`FirestoreFieldTtlConfigOutputReference`	No description.
`CollectionInput`	`*string`	No description.
`DatabaseInput`	`*string`	No description.
`FieldInput`	`*string`	No description.
`IdInput`	`*string`	No description.
`IndexConfigInput`	`FirestoreFieldIndexConfig`	No description.
`ProjectInput`	`*string`	No description.
`TimeoutsInput`	`interface{}`	No description.
`TtlConfigInput`	`FirestoreFieldTtlConfig`	No description.
`Collection`	`*string`	No description.
`Database`	`*string`	No description.
`Field`	`*string`	No description.
`Id`	`*string`	No description.
`Project`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`IndexConfig`^Required

func IndexConfig() FirestoreFieldIndexConfigOutputReference

Type: FirestoreFieldIndexConfigOutputReference

`Name`^Required

func Name() *string

Type: *string

`Timeouts`^Required

func Timeouts() FirestoreFieldTimeoutsOutputReference

Type: FirestoreFieldTimeoutsOutputReference

`TtlConfig`^Required

func TtlConfig() FirestoreFieldTtlConfigOutputReference

Type: FirestoreFieldTtlConfigOutputReference

`CollectionInput`^Optional

func CollectionInput() *string

Type: *string

`DatabaseInput`^Optional

func DatabaseInput() *string

Type: *string

`FieldInput`^Optional

func FieldInput() *string

Type: *string

`IdInput`^Optional

func IdInput() *string

Type: *string

`IndexConfigInput`^Optional

func IndexConfigInput() FirestoreFieldIndexConfig

Type: FirestoreFieldIndexConfig

`ProjectInput`^Optional

func ProjectInput() *string

Type: *string

`TimeoutsInput`^Optional

func TimeoutsInput() interface{}

Type: interface{}

`TtlConfigInput`^Optional

func TtlConfigInput() FirestoreFieldTtlConfig

Type: FirestoreFieldTtlConfig

`Collection`^Required

func Collection() *string

Type: *string

`Database`^Required

func Database() *string

Type: *string

`Field`^Required

func Field() *string

Type: *string

`Id`^Required

func Id() *string

Type: *string

`Project`^Required

func Project() *string

Type: *string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

FirestoreFieldConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

&firestorefield.FirestoreFieldConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Collection: *string,
	Field: *string,
	Database: *string,
	Id: *string,
	IndexConfig: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreField.FirestoreFieldIndexConfig,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreField.FirestoreFieldTimeouts,
	TtlConfig: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreField.FirestoreFieldTtlConfig,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`Collection`	`*string`	The id of the collection group to configure.
`Field`	`*string`	The id of the field to configure.
`Database`	`*string`	The Firestore database id. Defaults to '"(default)"'.
`Id`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#id FirestoreField#id}.
`IndexConfig`	`FirestoreFieldIndexConfig`	index_config block.
`Project`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#project FirestoreField#project}.
`Timeouts`	`FirestoreFieldTimeouts`	timeouts block.
`TtlConfig`	`FirestoreFieldTtlConfig`	ttl_config block.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`Collection`^Required

Collection *string

Type: *string

The id of the collection group to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#collection FirestoreField#collection}

`Field`^Required

Field *string

Type: *string

The id of the field to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#field FirestoreField#field}

`Database`^Optional

Database *string

Type: *string

The Firestore database id. Defaults to '"(default)"'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#database FirestoreField#database}

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#id FirestoreField#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.

`IndexConfig`^Optional

IndexConfig FirestoreFieldIndexConfig

Type: FirestoreFieldIndexConfig

index_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#index_config FirestoreField#index_config}

`Project`^Optional

Project *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#project FirestoreField#project}.

`Timeouts`^Optional

Timeouts FirestoreFieldTimeouts

Type: FirestoreFieldTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#timeouts FirestoreField#timeouts}

`TtlConfig`^Optional

TtlConfig FirestoreFieldTtlConfig

Type: FirestoreFieldTtlConfig

ttl_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#ttl_config FirestoreField#ttl_config}

FirestoreFieldIndexConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

&firestorefield.FirestoreFieldIndexConfig {
	Indexes: interface{},
}

Properties

Name	Type	Description
`Indexes`	`interface{}`	indexes block.

`Indexes`^Optional

Indexes interface{}

Type: interface{}

indexes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#indexes FirestoreField#indexes}

FirestoreFieldIndexConfigIndexes

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

&firestorefield.FirestoreFieldIndexConfigIndexes {
	ArrayConfig: *string,
	Order: *string,
	QueryScope: *string,
}

Properties

Name	Type	Description
`ArrayConfig`	`*string`	Indicates that this field supports operations on arrayValues. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["CONTAINS"].
`Order`	`*string`	Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=, !=. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"].
`QueryScope`	`*string`	The scope at which a query is run.

`ArrayConfig`^Optional

ArrayConfig *string

Type: *string

Indicates that this field supports operations on arrayValues. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["CONTAINS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#array_config FirestoreField#array_config}

`Order`^Optional

Order *string

Type: *string

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=, !=. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#order FirestoreField#order}

`QueryScope`^Optional

QueryScope *string

Type: *string

The scope at which a query is run.

Collection scoped queries require you specify the collection at query time. Collection group scope allows queries across all collections with the same id. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#query_scope FirestoreField#query_scope}

FirestoreFieldTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

&firestorefield.FirestoreFieldTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name	Type	Description
`Create`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#create FirestoreField#create}.
`Delete`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#delete FirestoreField#delete}.
`Update`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#update FirestoreField#update}.

`Create`^Optional

Create *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#create FirestoreField#create}.

`Delete`^Optional

Delete *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#delete FirestoreField#delete}.

`Update`^Optional

Update *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_field#update FirestoreField#update}.

FirestoreFieldTtlConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

&firestorefield.FirestoreFieldTtlConfig {

}

Classes

FirestoreFieldIndexConfigIndexesList

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreFieldIndexConfigIndexesList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) FirestoreFieldIndexConfigIndexesList

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`*bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: *string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: *bool

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

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) FirestoreFieldIndexConfigIndexesOutputReference

`index`^Required

Type: *f64

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`	`interface{}`	No description.

`CreationStack`^Required

func 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.

`Fqn`^Required

func Fqn() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

FirestoreFieldIndexConfigIndexesOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreFieldIndexConfigIndexesOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) FirestoreFieldIndexConfigIndexesOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`*f64`	the index of this item in the list.
`complexObjectIsFromSet`	`*bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: *string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: *f64

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: *bool

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.
`ResetArrayConfig`	No description.
`ResetOrder`	No description.
`ResetQueryScope`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetArrayConfig`

func ResetArrayConfig()

`ResetOrder`

func ResetOrder()

`ResetQueryScope`

func ResetQueryScope()

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.
`ArrayConfigInput`	`*string`	No description.
`OrderInput`	`*string`	No description.
`QueryScopeInput`	`*string`	No description.
`ArrayConfig`	`*string`	No description.
`Order`	`*string`	No description.
`QueryScope`	`*string`	No description.
`InternalValue`	`interface{}`	No description.

`CreationStack`^Required

func 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.

`Fqn`^Required

func Fqn() *string

Type: *string

`ArrayConfigInput`^Optional

func ArrayConfigInput() *string

Type: *string

`OrderInput`^Optional

func OrderInput() *string

Type: *string

`QueryScopeInput`^Optional

func QueryScopeInput() *string

Type: *string

`ArrayConfig`^Required

func ArrayConfig() *string

Type: *string

`Order`^Required

func Order() *string

Type: *string

`QueryScope`^Required

func QueryScope() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

FirestoreFieldIndexConfigOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreFieldIndexConfigOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreFieldIndexConfigOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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.
`PutIndexes`	No description.
`ResetIndexes`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`PutIndexes`

func PutIndexes(value interface{})

`value`^Required

Type: interface{}

`ResetIndexes`

func ResetIndexes()

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.
`Indexes`	`FirestoreFieldIndexConfigIndexesList`	No description.
`IndexesInput`	`interface{}`	No description.
`InternalValue`	`FirestoreFieldIndexConfig`	No description.

`CreationStack`^Required

func 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.

`Fqn`^Required

func Fqn() *string

Type: *string

`Indexes`^Required

func Indexes() FirestoreFieldIndexConfigIndexesList

Type: FirestoreFieldIndexConfigIndexesList

`IndexesInput`^Optional

func IndexesInput() interface{}

Type: interface{}

`InternalValue`^Optional

func InternalValue() FirestoreFieldIndexConfig

Type: FirestoreFieldIndexConfig

FirestoreFieldTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreFieldTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreFieldTimeoutsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

func ResetCreate()

`ResetDelete`

func ResetDelete()

`ResetUpdate`

func ResetUpdate()

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`	`interface{}`	No description.

`CreationStack`^Required

func 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.

`Fqn`^Required

func Fqn() *string

Type: *string

`CreateInput`^Optional

func CreateInput() *string

Type: *string

`DeleteInput`^Optional

func DeleteInput() *string

Type: *string

`UpdateInput`^Optional

func UpdateInput() *string

Type: *string

`Create`^Required

func Create() *string

Type: *string

`Delete`^Required

func Delete() *string

Type: *string

`Update`^Required

func Update() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

FirestoreFieldTtlConfigOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestorefield"

firestorefield.NewFirestoreFieldTtlConfigOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreFieldTtlConfigOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func 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.
`State`	`*string`	No description.
`InternalValue`	`FirestoreFieldTtlConfig`	No description.

`CreationStack`^Required

func 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.

`Fqn`^Required

func Fqn() *string

Type: *string

`State`^Required

func State() *string

Type: *string

`InternalValue`^Optional

func InternalValue() FirestoreFieldTtlConfig

Type: FirestoreFieldTtlConfig

Files

firestoreField.go.md

Latest commit

History

firestoreField.go.md

File metadata and controls

firestoreField Submodule

Constructs

FirestoreField

Initializers

scopeRequired

idRequired

configRequired

Methods

ToString

AddOverride

pathRequired

valueRequired

OverrideLogicalId

newLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

moveTargetRequired

GetAnyMapAttribute

terraformAttributeRequired

GetBooleanAttribute

terraformAttributeRequired

GetBooleanMapAttribute

terraformAttributeRequired

GetListAttribute

terraformAttributeRequired

GetNumberAttribute

terraformAttributeRequired

GetNumberListAttribute

terraformAttributeRequired

GetNumberMapAttribute

terraformAttributeRequired

GetStringAttribute

terraformAttributeRequired

GetStringMapAttribute

terraformAttributeRequired

HasResourceMove

ImportFrom

idRequired

providerOptional

InterpolationForAttribute

terraformAttributeRequired

MoveFromId

idRequired

MoveTo

moveTargetRequired

indexOptional

MoveToId

idRequired

PutIndexConfig

valueRequired

PutTimeouts

valueRequired

PutTtlConfig

valueRequired

ResetDatabase

ResetId

ResetIndexConfig

ResetProject

ResetTimeouts

ResetTtlConfig

Static Functions

IsConstruct

xRequired

IsTerraformElement

xRequired

IsTerraformResource

xRequired

GenerateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

`firestoreField` Submodule

`scope`^Required

`id`^Required

`config`^Required

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`moveTarget`^Required

`GetAnyMapAttribute`

`terraformAttribute`^Required

`GetBooleanAttribute`

`terraformAttribute`^Required

`GetBooleanMapAttribute`

`terraformAttribute`^Required

`GetListAttribute`

`terraformAttribute`^Required

`GetNumberAttribute`

`terraformAttribute`^Required

`GetNumberListAttribute`

`terraformAttribute`^Required

`GetNumberMapAttribute`

`terraformAttribute`^Required

`GetStringAttribute`

`terraformAttribute`^Required

`GetStringMapAttribute`

`terraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`id`^Required

`provider`^Optional

`InterpolationForAttribute`

`terraformAttribute`^Required

`MoveFromId`

`id`^Required

`MoveTo`

`moveTarget`^Required

`index`^Optional

`MoveToId`

`id`^Required

`PutIndexConfig`

`value`^Required

`PutTimeouts`

`value`^Required

`PutTtlConfig`

`value`^Required

`ResetDatabase`

`ResetId`

`ResetIndexConfig`

`ResetProject`

`ResetTimeouts`

`ResetTtlConfig`

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

`IsTerraformResource`

`x`^Required

`GenerateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional