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

Class FirestoreDatabase.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static FirestoreDatabase.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of FirestoreDatabase.Builder.

      • connection

        @Stability(Experimental)
public FirestoreDatabase.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public FirestoreDatabase.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FirestoreDatabase.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public FirestoreDatabase.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public FirestoreDatabase.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public FirestoreDatabase.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public FirestoreDatabase.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public FirestoreDatabase.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • locationId

        @Stability(Stable)
public FirestoreDatabase.Builder locationId​(String locationId)
        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/5.43.1/docs/resources/firestore_database#location_id FirestoreDatabase#location_id}

        Parameters:
        locationId - The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public FirestoreDatabase.Builder name​(String name)
        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/5.43.1/docs/resources/firestore_database#name FirestoreDatabase#name}

        Parameters:
        name - The ID to use for the database, which will become the final component of the database's resource name. This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public FirestoreDatabase.Builder type​(String type)
        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/5.43.1/docs/resources/firestore_database#type FirestoreDatabase#type}

        Parameters:
        type - 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"]. This parameter is required.
        Returns:
        this

      • appEngineIntegrationMode

        @Stability(Stable)
public FirestoreDatabase.Builder appEngineIntegrationMode​(String appEngineIntegrationMode)
        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/5.43.1/docs/resources/firestore_database#app_engine_integration_mode FirestoreDatabase#app_engine_integration_mode}

        Parameters:
        appEngineIntegrationMode - The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"]. This parameter is required.
        Returns:
        this

      • cmekConfig

        @Stability(Stable)
public FirestoreDatabase.Builder cmekConfig​(FirestoreDatabaseCmekConfig cmekConfig)
        cmek_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#cmek_config FirestoreDatabase#cmek_config}

        Parameters:
        cmekConfig - cmek_config block. This parameter is required.
        Returns:
        this

      • concurrencyMode

        @Stability(Stable)
public FirestoreDatabase.Builder concurrencyMode​(String concurrencyMode)
        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/5.43.1/docs/resources/firestore_database#concurrency_mode FirestoreDatabase#concurrency_mode}

        Parameters:
        concurrencyMode - The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"]. This parameter is required.
        Returns:
        this

      • deleteProtectionState

        @Stability(Stable)
public FirestoreDatabase.Builder deleteProtectionState​(String deleteProtectionState)
        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/5.43.1/docs/resources/firestore_database#delete_protection_state FirestoreDatabase#delete_protection_state}

        Parameters:
        deleteProtectionState - State of delete protection for the database. This parameter is required.
        Returns:
        this

      • deletionPolicy

        @Stability(Stable)
public FirestoreDatabase.Builder deletionPolicy​(String deletionPolicy)
        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/5.43.1/docs/resources/firestore_database#deletion_policy FirestoreDatabase#deletion_policy}

        Parameters:
        deletionPolicy - Deletion behavior for this database. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public FirestoreDatabase.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#id FirestoreDatabase#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#id FirestoreDatabase#id}. This parameter is required.
        Returns:
        this

      • pointInTimeRecoveryEnablement

        @Stability(Stable)
public FirestoreDatabase.Builder pointInTimeRecoveryEnablement​(String pointInTimeRecoveryEnablement)
        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/5.43.1/docs/resources/firestore_database#point_in_time_recovery_enablement FirestoreDatabase#point_in_time_recovery_enablement}

        Parameters:
        pointInTimeRecoveryEnablement - Whether to enable the PITR feature on this database. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public FirestoreDatabase.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#project FirestoreDatabase#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#project FirestoreDatabase#project}. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public FirestoreDatabase.Builder timeouts​(FirestoreDatabaseTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#timeouts FirestoreDatabase#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this