Package com.hashicorp.cdktf.providers.google.firestore_database

Class FirestoreDatabase

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.231Z")
@Stability(Stable)
public class FirestoreDatabase
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database google_firestore_database}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • FirestoreDatabase

        protected FirestoreDatabase​(software.amazon.jsii.JsiiObjectRef objRef)

      • FirestoreDatabase

        protected FirestoreDatabase​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • FirestoreDatabase

        @Stability(Stable)
public FirestoreDatabase​(@NotNull
                         software.constructs.Construct scope,
                         @NotNull
                         String id,
                         @NotNull
                         FirestoreDatabaseConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database google_firestore_database} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a FirestoreDatabase resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the FirestoreDatabase to import. This parameter is required.
        importFromId - The id of the existing FirestoreDatabase that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the FirestoreDatabase to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a FirestoreDatabase resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the FirestoreDatabase to import. This parameter is required.
        importFromId - The id of the existing FirestoreDatabase that should be imported. This parameter is required.

      • putCmekConfig

        @Stability(Stable)
public void putCmekConfig​(@NotNull
                          FirestoreDatabaseCmekConfig value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        FirestoreDatabaseTimeouts value)
        Parameters:
        value - This parameter is required.

      • resetAppEngineIntegrationMode

        @Stability(Stable)
public void resetAppEngineIntegrationMode()

      • resetCmekConfig

        @Stability(Stable)
public void resetCmekConfig()

      • resetConcurrencyMode

        @Stability(Stable)
public void resetConcurrencyMode()

      • resetDeleteProtectionState

        @Stability(Stable)
public void resetDeleteProtectionState()

      • resetDeletionPolicy

        @Stability(Stable)
public void resetDeletionPolicy()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetPointInTimeRecoveryEnablement

        @Stability(Stable)
public void resetPointInTimeRecoveryEnablement()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getCreateTime

        @Stability(Stable)
@NotNull
public String getCreateTime()

      • getEarliestVersionTime

        @Stability(Stable)
@NotNull
public String getEarliestVersionTime()

      • getEtag

        @Stability(Stable)
@NotNull
public String getEtag()

      • getKeyPrefix

        @Stability(Stable)
@NotNull
public String getKeyPrefix()

      • getUid

        @Stability(Stable)
@NotNull
public String getUid()

      • getUpdateTime

        @Stability(Stable)
@NotNull
public String getUpdateTime()

      • getVersionRetentionPeriod

        @Stability(Stable)
@NotNull
public String getVersionRetentionPeriod()

      • getAppEngineIntegrationModeInput

        @Stability(Stable)
@Nullable
public String getAppEngineIntegrationModeInput()

      • getConcurrencyModeInput

        @Stability(Stable)
@Nullable
public String getConcurrencyModeInput()

      • getDeleteProtectionStateInput

        @Stability(Stable)
@Nullable
public String getDeleteProtectionStateInput()

      • getDeletionPolicyInput

        @Stability(Stable)
@Nullable
public String getDeletionPolicyInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getLocationIdInput

        @Stability(Stable)
@Nullable
public String getLocationIdInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getPointInTimeRecoveryEnablementInput

        @Stability(Stable)
@Nullable
public String getPointInTimeRecoveryEnablementInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getTypeInput

        @Stability(Stable)
@Nullable
public String getTypeInput()

      • getAppEngineIntegrationMode

        @Stability(Stable)
@NotNull
public String getAppEngineIntegrationMode()

      • setAppEngineIntegrationMode

        @Stability(Stable)
public void setAppEngineIntegrationMode​(@NotNull
                                        String value)

      • getConcurrencyMode

        @Stability(Stable)
@NotNull
public String getConcurrencyMode()

      • setConcurrencyMode

        @Stability(Stable)
public void setConcurrencyMode​(@NotNull
                               String value)

      • getDeleteProtectionState

        @Stability(Stable)
@NotNull
public String getDeleteProtectionState()

      • setDeleteProtectionState

        @Stability(Stable)
public void setDeleteProtectionState​(@NotNull
                                     String value)

      • getDeletionPolicy

        @Stability(Stable)
@NotNull
public String getDeletionPolicy()

      • setDeletionPolicy

        @Stability(Stable)
public void setDeletionPolicy​(@NotNull
                              String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getLocationId

        @Stability(Stable)
@NotNull
public String getLocationId()

      • setLocationId

        @Stability(Stable)
public void setLocationId​(@NotNull
                          String value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getPointInTimeRecoveryEnablement

        @Stability(Stable)
@NotNull
public String getPointInTimeRecoveryEnablement()

      • setPointInTimeRecoveryEnablement

        @Stability(Stable)
public void setPointInTimeRecoveryEnablement​(@NotNull
                                             String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getType

        @Stability(Stable)
@NotNull
public String getType()

      • setType

        @Stability(Stable)
public void setType​(@NotNull
                    String value)