Class SpannerDatabase

  • 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:22.743Z")
    @Stability(Stable)
    public class SpannerDatabase
    extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_database google_spanner_database}.
    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
        public static final String TF_RESOURCE_TYPE
    • Constructor Detail

      • SpannerDatabase

        protected SpannerDatabase​(software.amazon.jsii.JsiiObjectRef objRef)
      • SpannerDatabase

        protected SpannerDatabase​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
      • SpannerDatabase

        @Stability(Stable)
        public SpannerDatabase​(@NotNull
                               software.constructs.Construct scope,
                               @NotNull
                               String id,
                               @NotNull
                               SpannerDatabaseConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_database google_spanner_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 SpannerDatabase 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 SpannerDatabase to import. This parameter is required.
        importFromId - The id of the existing SpannerDatabase that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the SpannerDatabase 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 SpannerDatabase 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 SpannerDatabase to import. This parameter is required.
        importFromId - The id of the existing SpannerDatabase that should be imported. This parameter is required.
      • putEncryptionConfig

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

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

        @Stability(Stable)
        public void resetDatabaseDialect()
      • resetDdl

        @Stability(Stable)
        public void resetDdl()
      • resetDeletionProtection

        @Stability(Stable)
        public void resetDeletionProtection()
      • resetEnableDropProtection

        @Stability(Stable)
        public void resetEnableDropProtection()
      • resetEncryptionConfig

        @Stability(Stable)
        public void resetEncryptionConfig()
      • resetId

        @Stability(Stable)
        public void resetId()
      • resetProject

        @Stability(Stable)
        public void resetProject()
      • resetTimeouts

        @Stability(Stable)
        public void resetTimeouts()
      • resetVersionRetentionPeriod

        @Stability(Stable)
        public void resetVersionRetentionPeriod()
      • 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
      • getState

        @Stability(Stable)
        @NotNull
        public String getState()
      • getDatabaseDialectInput

        @Stability(Stable)
        @Nullable
        public String getDatabaseDialectInput()
      • getDdlInput

        @Stability(Stable)
        @Nullable
        public List<String> getDdlInput()
      • getDeletionProtectionInput

        @Stability(Stable)
        @Nullable
        public Object getDeletionProtectionInput()
      • getEnableDropProtectionInput

        @Stability(Stable)
        @Nullable
        public Object getEnableDropProtectionInput()
      • getIdInput

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

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

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

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

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

        @Stability(Stable)
        @Nullable
        public String getVersionRetentionPeriodInput()
      • getDatabaseDialect

        @Stability(Stable)
        @NotNull
        public String getDatabaseDialect()
      • setDatabaseDialect

        @Stability(Stable)
        public void setDatabaseDialect​(@NotNull
                                       String value)
      • getDdl

        @Stability(Stable)
        @NotNull
        public List<String> getDdl()
      • setDdl

        @Stability(Stable)
        public void setDdl​(@NotNull
                           List<String> value)
      • getDeletionProtection

        @Stability(Stable)
        @NotNull
        public Object getDeletionProtection()
      • setDeletionProtection

        @Stability(Stable)
        public void setDeletionProtection​(@NotNull
                                          Boolean value)
      • setDeletionProtection

        @Stability(Stable)
        public void setDeletionProtection​(@NotNull
                                          com.hashicorp.cdktf.IResolvable value)
      • getEnableDropProtection

        @Stability(Stable)
        @NotNull
        public Object getEnableDropProtection()
      • setEnableDropProtection

        @Stability(Stable)
        public void setEnableDropProtection​(@NotNull
                                            Boolean value)
      • setEnableDropProtection

        @Stability(Stable)
        public void setEnableDropProtection​(@NotNull
                                            com.hashicorp.cdktf.IResolvable value)
      • getId

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

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

        @Stability(Stable)
        @NotNull
        public String getInstance()
      • setInstance

        @Stability(Stable)
        public void setInstance​(@NotNull
                                String value)
      • getName

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

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

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

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

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

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