Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document google_firestore_document}.
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.NewFirestoreDocument(scope Construct, id *string, config FirestoreDocumentConfig) FirestoreDocument
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 |
FirestoreDocumentConfig |
No description. |
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
- Type: *string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: FirestoreDocumentConfig
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". |
PutTimeouts |
No description. |
ResetDatabase |
No description. |
ResetId |
No description. |
ResetProject |
No description. |
ResetTimeouts |
No description. |
func ToString() *string
Returns a string representation of this construct.
func AddOverride(path *string, value interface{})
- Type: *string
- Type: interface{}
func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.
- Type: *string
The new logical ID to use for this stack element.
func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
func ToHclTerraform() interface{}
func ToMetadata() interface{}
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
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.
- Type: *string
The string move target that will correspond to this resource.
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
- Type: *string
func GetBooleanAttribute(terraformAttribute *string) IResolvable
- Type: *string
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
- Type: *string
func GetListAttribute(terraformAttribute *string) *[]*string
- Type: *string
func GetNumberAttribute(terraformAttribute *string) *f64
- Type: *string
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
- Type: *string
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
- Type: *string
func GetStringAttribute(terraformAttribute *string) *string
- Type: *string
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
- Type: *string
func HasResourceMove() interface{}
func ImportFrom(id *string, provider TerraformProvider)
- Type: *string
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func InterpolationForAttribute(terraformAttribute *string) IResolvable
- Type: *string
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.
- Type: *string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
func MoveTo(moveTarget *string, index interface{})
Moves this resource to the target resource given by moveTarget.
- Type: *string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: interface{}
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
func MoveToId(id *string)
Moves this resource to the resource corresponding to "id".
- Type: *string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
func PutTimeouts(value FirestoreDocumentTimeouts)
func ResetDatabase()
func ResetId()
func ResetProject()
func ResetTimeouts()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a FirestoreDocument resource upon running "cdktf plan ". |
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.FirestoreDocument_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.
- Type: interface{}
Any object.
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.FirestoreDocument_IsTerraformElement(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.FirestoreDocument_IsTerraformResource(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.FirestoreDocument_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource
Generates CDKTF code for importing a FirestoreDocument resource upon running "cdktf plan ".
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
- Type: *string
The construct id used in the generated config for the FirestoreDocument to import.
- Type: *string
The id of the existing FirestoreDocument that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#import import section} in the documentation of this resource for the id to use
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
? Optional instance of the provider where the FirestoreDocument to import is found.
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. |
CreateTime |
*string |
No description. |
Name |
*string |
No description. |
Path |
*string |
No description. |
Timeouts |
FirestoreDocumentTimeoutsOutputReference |
No description. |
UpdateTime |
*string |
No description. |
CollectionInput |
*string |
No description. |
DatabaseInput |
*string |
No description. |
DocumentIdInput |
*string |
No description. |
FieldsInput |
*string |
No description. |
IdInput |
*string |
No description. |
ProjectInput |
*string |
No description. |
TimeoutsInput |
interface{} |
No description. |
Collection |
*string |
No description. |
Database |
*string |
No description. |
DocumentId |
*string |
No description. |
Fields |
*string |
No description. |
Id |
*string |
No description. |
Project |
*string |
No description. |
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
func CdktfStack() TerraformStack
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
func Fqn() *string
- Type: *string
func FriendlyUniqueId() *string
- Type: *string
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
func TerraformResourceType() *string
- Type: *string
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
func Connection() interface{}
- Type: interface{}
func Count() interface{}
- Type: interface{}
func DependsOn() *[]*string
- Type: *[]*string
func ForEach() ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
func Lifecycle() TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
func Provider() TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func Provisioners() *[]interface{}
- Type: *[]interface{}
func CreateTime() *string
- Type: *string
func Name() *string
- Type: *string
func Path() *string
- Type: *string
func Timeouts() FirestoreDocumentTimeoutsOutputReference
func UpdateTime() *string
- Type: *string
func CollectionInput() *string
- Type: *string
func DatabaseInput() *string
- Type: *string
func DocumentIdInput() *string
- Type: *string
func FieldsInput() *string
- Type: *string
func IdInput() *string
- Type: *string
func ProjectInput() *string
- Type: *string
func TimeoutsInput() interface{}
- Type: interface{}
func Collection() *string
- Type: *string
func Database() *string
- Type: *string
func DocumentId() *string
- Type: *string
func Fields() *string
- Type: *string
func Id() *string
- Type: *string
func Project() *string
- Type: *string
Name | Type | Description |
---|---|---|
TfResourceType |
*string |
No description. |
func TfResourceType() *string
- Type: *string
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
&firestoredocument.FirestoreDocumentConfig {
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,
DocumentId: *string,
Fields: *string,
Database: *string,
Id: *string,
Project: *string,
Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreDocument.FirestoreDocumentTimeouts,
}
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 collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. |
DocumentId |
*string |
The client-assigned document ID to use for this document during creation. |
Fields |
*string |
The document's fields formated as a json string. |
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_document#id FirestoreDocument#id}. |
Project |
*string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#project FirestoreDocument#project}. |
Timeouts |
FirestoreDocumentTimeouts |
timeouts block. |
Connection interface{}
- Type: interface{}
Count interface{}
- Type: interface{}
DependsOn *[]ITerraformDependable
- Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEach ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
Lifecycle TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
Provider TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
Provisioners *[]interface{}
- Type: *[]interface{}
Collection *string
- Type: *string
The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#collection FirestoreDocument#collection}
DocumentId *string
- Type: *string
The client-assigned document ID to use for this document during creation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#document_id FirestoreDocument#document_id}
Fields *string
- Type: *string
The document's fields formated as a json string.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#fields FirestoreDocument#fields}
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_document#database FirestoreDocument#database}
Id *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#id FirestoreDocument#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.
Project *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#project FirestoreDocument#project}.
Timeouts FirestoreDocumentTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#timeouts FirestoreDocument#timeouts}
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
&firestoredocument.FirestoreDocumentTimeouts {
Create: *string,
Delete: *string,
Update: *string,
}
Name | Type | Description |
---|---|---|
Create |
*string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#create FirestoreDocument#create}. |
Delete |
*string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#delete FirestoreDocument#delete}. |
Update |
*string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#update FirestoreDocument#update}. |
Create *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#create FirestoreDocument#create}.
Delete *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#delete FirestoreDocument#delete}.
Update *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_document#update FirestoreDocument#update}.
import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredocument"
firestoredocument.NewFirestoreDocumentTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreDocumentTimeoutsOutputReference
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. |
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent
The parent resource.
- Type: *string
The attribute on the parent resource this class is referencing.
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. |
func ComputeFqn() *string
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
- Type: *string
func GetBooleanAttribute(terraformAttribute *string) IResolvable
- Type: *string
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
- Type: *string
func GetListAttribute(terraformAttribute *string) *[]*string
- Type: *string
func GetNumberAttribute(terraformAttribute *string) *f64
- Type: *string
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
- Type: *string
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
- Type: *string
func GetStringAttribute(terraformAttribute *string) *string
- Type: *string
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
- Type: *string
func InterpolationForAttribute(property *string) IResolvable
- Type: *string
func Resolve(_context IResolveContext) interface{}
Produce the Token's value at resolution time.
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
func ToString() *string
Return a string representation of this resolvable object.
Returns a reversible string representation.
func ResetCreate()
func ResetDelete()
func ResetUpdate()
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. |
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.
func Fqn() *string
- Type: *string
func CreateInput() *string
- Type: *string
func DeleteInput() *string
- Type: *string
func UpdateInput() *string
- Type: *string
func Create() *string
- Type: *string
func Delete() *string
- Type: *string
func Update() *string
- Type: *string
func InternalValue() interface{}
- Type: interface{}