Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database google_firestore_database}.
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabase;
GoogleFirestoreDatabase.Builder.create(Construct scope, java.lang.String id)
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.locationId(java.lang.String)
.name(java.lang.String)
.type(java.lang.String)
// .appEngineIntegrationMode(java.lang.String)
// .cmekConfig(GoogleFirestoreDatabaseCmekConfig)
// .concurrencyMode(java.lang.String)
// .deleteProtectionState(java.lang.String)
// .deletionPolicy(java.lang.String)
// .id(java.lang.String)
// .pointInTimeRecoveryEnablement(java.lang.String)
// .project(java.lang.String)
// .timeouts(GoogleFirestoreDatabaseTimeouts)
.build();
Name | Type | Description |
---|---|---|
scope |
software.constructs.Construct |
The scope in which to define this construct. |
id |
java.lang.String |
The scoped construct ID. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
locationId |
java.lang.String |
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. |
name |
java.lang.String |
The ID to use for the database, which will become the final component of the database's resource name. |
type |
java.lang.String |
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"]. |
appEngineIntegrationMode |
java.lang.String |
The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"]. |
cmekConfig |
GoogleFirestoreDatabaseCmekConfig |
cmek_config block. |
concurrencyMode |
java.lang.String |
The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"]. |
deleteProtectionState |
java.lang.String |
State of delete protection for the database. |
deletionPolicy |
java.lang.String |
Deletion behavior for this database. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#id GoogleFirestoreDatabase#id}. |
pointInTimeRecoveryEnablement |
java.lang.String |
Whether to enable the PITR feature on this database. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#project GoogleFirestoreDatabase#project}. |
timeouts |
GoogleFirestoreDatabaseTimeouts |
timeouts block. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#location_id GoogleFirestoreDatabase#location_id}
- Type: java.lang.String
The ID to use for the database, which will become the final component of the database's resource name.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#name GoogleFirestoreDatabase#name}
- Type: java.lang.String
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#type GoogleFirestoreDatabase#type}
- Type: java.lang.String
The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#app_engine_integration_mode GoogleFirestoreDatabase#app_engine_integration_mode}
cmek_config block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#cmek_config GoogleFirestoreDatabase#cmek_config}
- Type: java.lang.String
The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#concurrency_mode GoogleFirestoreDatabase#concurrency_mode}
- Type: java.lang.String
State of delete protection for the database.
When delete protection is enabled, this database cannot be deleted. The default value is 'DELETE_PROTECTION_STATE_UNSPECIFIED', which is currently equivalent to 'DELETE_PROTECTION_DISABLED'. Note: Additionally, to delete this database using 'terraform destroy', 'deletion_policy' must be set to 'DELETE'. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#delete_protection_state GoogleFirestoreDatabase#delete_protection_state}
- Type: java.lang.String
Deletion behavior for this database.
If the deletion policy is 'ABANDON', the database will be removed from Terraform state but not deleted from Google Cloud upon destruction. If the deletion policy is 'DELETE', the database will both be removed from Terraform state and deleted from Google Cloud upon destruction. The default value is 'ABANDON'. See also 'delete_protection'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#deletion_policy GoogleFirestoreDatabase#deletion_policy}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#id GoogleFirestoreDatabase#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.
- Type: java.lang.String
Whether to enable the PITR feature on this database.
If 'POINT_IN_TIME_RECOVERY_ENABLED' is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If 'POINT_IN_TIME_RECOVERY_DISABLED' is selected, reads are supported on any version of the data from within the past 1 hour. Default value: "POINT_IN_TIME_RECOVERY_DISABLED" Possible values: ["POINT_IN_TIME_RECOVERY_ENABLED", "POINT_IN_TIME_RECOVERY_DISABLED"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#point_in_time_recovery_enablement GoogleFirestoreDatabase#point_in_time_recovery_enablement}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#project GoogleFirestoreDatabase#project}.
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#timeouts GoogleFirestoreDatabase#timeouts}
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". |
putCmekConfig |
No description. |
putTimeouts |
No description. |
resetAppEngineIntegrationMode |
No description. |
resetCmekConfig |
No description. |
resetConcurrencyMode |
No description. |
resetDeleteProtectionState |
No description. |
resetDeletionPolicy |
No description. |
resetId |
No description. |
resetPointInTimeRecoveryEnablement |
No description. |
resetProject |
No description. |
resetTimeouts |
No description. |
public java.lang.String toString()
Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.
public void addMoveTarget(java.lang.String moveTarget)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public void moveFromId(java.lang.String id)
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: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)
Moves this resource to the target resource given by moveTarget.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: java.lang.String OR java.lang.Number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public void moveToId(java.lang.String id)
Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putCmekConfig(GoogleFirestoreDatabaseCmekConfig value)
public void putTimeouts(GoogleFirestoreDatabaseTimeouts value)
public void resetAppEngineIntegrationMode()
public void resetCmekConfig()
public void resetConcurrencyMode()
public void resetDeleteProtectionState()
public void resetDeletionPolicy()
public void resetId()
public void resetPointInTimeRecoveryEnablement()
public void resetProject()
public void resetTimeouts()
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GoogleFirestoreDatabase resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabase;
GoogleFirestoreDatabase.isConstruct(java.lang.Object x)
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: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabase;
GoogleFirestoreDatabase.isTerraformElement(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabase;
GoogleFirestoreDatabase.isTerraformResource(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabase;
GoogleFirestoreDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GoogleFirestoreDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)
Generates CDKTF code for importing a GoogleFirestoreDatabase resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the GoogleFirestoreDatabase to import.
- Type: java.lang.String
The id of the existing GoogleFirestoreDatabase that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the GoogleFirestoreDatabase to import is found.
Name | Type | Description |
---|---|---|
node |
software.constructs.Node |
The tree node. |
cdktfStack |
com.hashicorp.cdktf.TerraformStack |
No description. |
fqn |
java.lang.String |
No description. |
friendlyUniqueId |
java.lang.String |
No description. |
terraformMetaArguments |
java.util.Map<java.lang.String, java.lang.Object> |
No description. |
terraformResourceType |
java.lang.String |
No description. |
terraformGeneratorMetadata |
com.hashicorp.cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<java.lang.String> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
cmekConfig |
GoogleFirestoreDatabaseCmekConfigOutputReference |
No description. |
createTime |
java.lang.String |
No description. |
earliestVersionTime |
java.lang.String |
No description. |
etag |
java.lang.String |
No description. |
keyPrefix |
java.lang.String |
No description. |
timeouts |
GoogleFirestoreDatabaseTimeoutsOutputReference |
No description. |
uid |
java.lang.String |
No description. |
updateTime |
java.lang.String |
No description. |
versionRetentionPeriod |
java.lang.String |
No description. |
appEngineIntegrationModeInput |
java.lang.String |
No description. |
cmekConfigInput |
GoogleFirestoreDatabaseCmekConfig |
No description. |
concurrencyModeInput |
java.lang.String |
No description. |
deleteProtectionStateInput |
java.lang.String |
No description. |
deletionPolicyInput |
java.lang.String |
No description. |
idInput |
java.lang.String |
No description. |
locationIdInput |
java.lang.String |
No description. |
nameInput |
java.lang.String |
No description. |
pointInTimeRecoveryEnablementInput |
java.lang.String |
No description. |
projectInput |
java.lang.String |
No description. |
timeoutsInput |
com.hashicorp.cdktf.IResolvable OR GoogleFirestoreDatabaseTimeouts |
No description. |
typeInput |
java.lang.String |
No description. |
appEngineIntegrationMode |
java.lang.String |
No description. |
concurrencyMode |
java.lang.String |
No description. |
deleteProtectionState |
java.lang.String |
No description. |
deletionPolicy |
java.lang.String |
No description. |
id |
java.lang.String |
No description. |
locationId |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
pointInTimeRecoveryEnablement |
java.lang.String |
No description. |
project |
java.lang.String |
No description. |
type |
java.lang.String |
No description. |
public Node getNode();
- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();
- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public GoogleFirestoreDatabaseCmekConfigOutputReference getCmekConfig();
public java.lang.String getCreateTime();
- Type: java.lang.String
public java.lang.String getEarliestVersionTime();
- Type: java.lang.String
public java.lang.String getEtag();
- Type: java.lang.String
public java.lang.String getKeyPrefix();
- Type: java.lang.String
public GoogleFirestoreDatabaseTimeoutsOutputReference getTimeouts();
public java.lang.String getUid();
- Type: java.lang.String
public java.lang.String getUpdateTime();
- Type: java.lang.String
public java.lang.String getVersionRetentionPeriod();
- Type: java.lang.String
public java.lang.String getAppEngineIntegrationModeInput();
- Type: java.lang.String
public GoogleFirestoreDatabaseCmekConfig getCmekConfigInput();
public java.lang.String getConcurrencyModeInput();
- Type: java.lang.String
public java.lang.String getDeleteProtectionStateInput();
- Type: java.lang.String
public java.lang.String getDeletionPolicyInput();
- Type: java.lang.String
public java.lang.String getIdInput();
- Type: java.lang.String
public java.lang.String getLocationIdInput();
- Type: java.lang.String
public java.lang.String getNameInput();
- Type: java.lang.String
public java.lang.String getPointInTimeRecoveryEnablementInput();
- Type: java.lang.String
public java.lang.String getProjectInput();
- Type: java.lang.String
public java.lang.Object getTimeoutsInput();
- Type: com.hashicorp.cdktf.IResolvable OR GoogleFirestoreDatabaseTimeouts
public java.lang.String getTypeInput();
- Type: java.lang.String
public java.lang.String getAppEngineIntegrationMode();
- Type: java.lang.String
public java.lang.String getConcurrencyMode();
- Type: java.lang.String
public java.lang.String getDeleteProtectionState();
- Type: java.lang.String
public java.lang.String getDeletionPolicy();
- Type: java.lang.String
public java.lang.String getId();
- Type: java.lang.String
public java.lang.String getLocationId();
- Type: java.lang.String
public java.lang.String getName();
- Type: java.lang.String
public java.lang.String getPointInTimeRecoveryEnablement();
- Type: java.lang.String
public java.lang.String getProject();
- Type: java.lang.String
public java.lang.String getType();
- Type: java.lang.String
Name | Type | Description |
---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();
- Type: java.lang.String
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabaseCmekConfig;
GoogleFirestoreDatabaseCmekConfig.builder()
.kmsKeyName(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
kmsKeyName |
java.lang.String |
The resource ID of a Cloud KMS key. |
public java.lang.String getKmsKeyName();
- Type: java.lang.String
The resource ID of a Cloud KMS key.
If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch.
Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations.
This value should be the KMS key resource ID in the format of 'projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}'. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#kms_key_name GoogleFirestoreDatabase#kms_key_name}
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabaseConfig;
GoogleFirestoreDatabaseConfig.builder()
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.locationId(java.lang.String)
.name(java.lang.String)
.type(java.lang.String)
// .appEngineIntegrationMode(java.lang.String)
// .cmekConfig(GoogleFirestoreDatabaseCmekConfig)
// .concurrencyMode(java.lang.String)
// .deleteProtectionState(java.lang.String)
// .deletionPolicy(java.lang.String)
// .id(java.lang.String)
// .pointInTimeRecoveryEnablement(java.lang.String)
// .project(java.lang.String)
// .timeouts(GoogleFirestoreDatabaseTimeouts)
.build();
Name | Type | Description |
---|---|---|
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
locationId |
java.lang.String |
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. |
name |
java.lang.String |
The ID to use for the database, which will become the final component of the database's resource name. |
type |
java.lang.String |
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"]. |
appEngineIntegrationMode |
java.lang.String |
The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"]. |
cmekConfig |
GoogleFirestoreDatabaseCmekConfig |
cmek_config block. |
concurrencyMode |
java.lang.String |
The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"]. |
deleteProtectionState |
java.lang.String |
State of delete protection for the database. |
deletionPolicy |
java.lang.String |
Deletion behavior for this database. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#id GoogleFirestoreDatabase#id}. |
pointInTimeRecoveryEnablement |
java.lang.String |
Whether to enable the PITR feature on this database. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#project GoogleFirestoreDatabase#project}. |
timeouts |
GoogleFirestoreDatabaseTimeouts |
timeouts block. |
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getLocationId();
- Type: java.lang.String
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#location_id GoogleFirestoreDatabase#location_id}
public java.lang.String getName();
- Type: java.lang.String
The ID to use for the database, which will become the final component of the database's resource name.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#name GoogleFirestoreDatabase#name}
public java.lang.String getType();
- Type: java.lang.String
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#type GoogleFirestoreDatabase#type}
public java.lang.String getAppEngineIntegrationMode();
- Type: java.lang.String
The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#app_engine_integration_mode GoogleFirestoreDatabase#app_engine_integration_mode}
public GoogleFirestoreDatabaseCmekConfig getCmekConfig();
cmek_config block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#cmek_config GoogleFirestoreDatabase#cmek_config}
public java.lang.String getConcurrencyMode();
- Type: java.lang.String
The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#concurrency_mode GoogleFirestoreDatabase#concurrency_mode}
public java.lang.String getDeleteProtectionState();
- Type: java.lang.String
State of delete protection for the database.
When delete protection is enabled, this database cannot be deleted. The default value is 'DELETE_PROTECTION_STATE_UNSPECIFIED', which is currently equivalent to 'DELETE_PROTECTION_DISABLED'. Note: Additionally, to delete this database using 'terraform destroy', 'deletion_policy' must be set to 'DELETE'. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#delete_protection_state GoogleFirestoreDatabase#delete_protection_state}
public java.lang.String getDeletionPolicy();
- Type: java.lang.String
Deletion behavior for this database.
If the deletion policy is 'ABANDON', the database will be removed from Terraform state but not deleted from Google Cloud upon destruction. If the deletion policy is 'DELETE', the database will both be removed from Terraform state and deleted from Google Cloud upon destruction. The default value is 'ABANDON'. See also 'delete_protection'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#deletion_policy GoogleFirestoreDatabase#deletion_policy}
public java.lang.String getId();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#id GoogleFirestoreDatabase#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.
public java.lang.String getPointInTimeRecoveryEnablement();
- Type: java.lang.String
Whether to enable the PITR feature on this database.
If 'POINT_IN_TIME_RECOVERY_ENABLED' is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If 'POINT_IN_TIME_RECOVERY_DISABLED' is selected, reads are supported on any version of the data from within the past 1 hour. Default value: "POINT_IN_TIME_RECOVERY_DISABLED" Possible values: ["POINT_IN_TIME_RECOVERY_ENABLED", "POINT_IN_TIME_RECOVERY_DISABLED"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#point_in_time_recovery_enablement GoogleFirestoreDatabase#point_in_time_recovery_enablement}
public java.lang.String getProject();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#project GoogleFirestoreDatabase#project}.
public GoogleFirestoreDatabaseTimeouts getTimeouts();
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#timeouts GoogleFirestoreDatabase#timeouts}
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabaseTimeouts;
GoogleFirestoreDatabaseTimeouts.builder()
// .create(java.lang.String)
// .delete(java.lang.String)
// .update(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
create |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#create GoogleFirestoreDatabase#create}. |
delete |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#delete GoogleFirestoreDatabase#delete}. |
update |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#update GoogleFirestoreDatabase#update}. |
public java.lang.String getCreate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#create GoogleFirestoreDatabase#create}.
public java.lang.String getDelete();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#delete GoogleFirestoreDatabase#delete}.
public java.lang.String getUpdate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_firestore_database#update GoogleFirestoreDatabase#update}.
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabaseCmekConfigOutputReference;
new GoogleFirestoreDatabaseCmekConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
activeKeyVersion |
java.util.List<java.lang.String> |
No description. |
kmsKeyNameInput |
java.lang.String |
No description. |
kmsKeyName |
java.lang.String |
No description. |
internalValue |
GoogleFirestoreDatabaseCmekConfig |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.util.List<java.lang.String> getActiveKeyVersion();
- Type: java.util.List<java.lang.String>
public java.lang.String getKmsKeyNameInput();
- Type: java.lang.String
public java.lang.String getKmsKeyName();
- Type: java.lang.String
public GoogleFirestoreDatabaseCmekConfig getInternalValue();
import com.hashicorp.cdktf.providers.google_beta.google_firestore_database.GoogleFirestoreDatabaseTimeoutsOutputReference;
new GoogleFirestoreDatabaseTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetCreate()
public void resetDelete()
public void resetUpdate()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
createInput |
java.lang.String |
No description. |
deleteInput |
java.lang.String |
No description. |
updateInput |
java.lang.String |
No description. |
create |
java.lang.String |
No description. |
delete |
java.lang.String |
No description. |
update |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR GoogleFirestoreDatabaseTimeouts |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getCreateInput();
- Type: java.lang.String
public java.lang.String getDeleteInput();
- Type: java.lang.String
public java.lang.String getUpdateInput();
- Type: java.lang.String
public java.lang.String getCreate();
- Type: java.lang.String
public java.lang.String getDelete();
- Type: java.lang.String
public java.lang.String getUpdate();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR GoogleFirestoreDatabaseTimeouts