Class SqlDatabase.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<SqlDatabase>
    Enclosing class:
    SqlDatabase

    @Stability(Stable)
    public static final class SqlDatabase.Builder
    extends Object
    implements software.amazon.jsii.Builder<SqlDatabase>
    A fluent builder for SqlDatabase.
    • Method Detail

      • create

        @Stability(Stable)
        public static SqlDatabase.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 SqlDatabase.Builder.
      • connection

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

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

        @Stability(Experimental)
        public SqlDatabase.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this
      • count

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

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

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

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

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

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

        @Stability(Stable)
        public SqlDatabase.Builder instance​(String instance)
        The name of the Cloud SQL instance. This does not include the project ID.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#instance SqlDatabase#instance}

        Parameters:
        instance - The name of the Cloud SQL instance. This does not include the project ID. This parameter is required.
        Returns:
        this
      • name

        @Stability(Stable)
        public SqlDatabase.Builder name​(String name)
        The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#name SqlDatabase#name}

        Parameters:
        name - The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. This parameter is required.
        Returns:
        this
      • charset

        @Stability(Stable)
        public SqlDatabase.Builder charset​(String charset)
        The charset value.

        See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html) for more details and supported values. Postgres databases only support a value of 'UTF8' at creation time. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#charset SqlDatabase#charset}

        Parameters:
        charset - The charset value. This parameter is required.
        Returns:
        this
      • collation

        @Stability(Stable)
        public SqlDatabase.Builder collation​(String collation)
        The collation value.

        See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html) for more details and supported values. Postgres databases only support a value of 'en_US.UTF8' at creation time. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#collation SqlDatabase#collation}

        Parameters:
        collation - The collation value. This parameter is required.
        Returns:
        this
      • deletionPolicy

        @Stability(Stable)
        public SqlDatabase.Builder deletionPolicy​(String deletionPolicy)
        The deletion policy for the database.

        Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be deleted from the API if there are users other than cloudsqlsuperuser with access. Possible values are: "ABANDON", "DELETE". Defaults to "DELETE". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#deletion_policy SqlDatabase#deletion_policy}

        Parameters:
        deletionPolicy - The deletion policy for the database. This parameter is required.
        Returns:
        this
      • id

        @Stability(Stable)
        public SqlDatabase.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database#id SqlDatabase#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/sql_database#id SqlDatabase#id}. This parameter is required.
        Returns:
        this
      • project

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

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

        @Stability(Stable)
        public SqlDatabase.Builder timeouts​(SqlDatabaseTimeouts timeouts)
        timeouts block.

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

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

        @Stability(Stable)
        public SqlDatabase build()
        Specified by:
        build in interface software.amazon.jsii.Builder<SqlDatabase>
        Returns:
        a newly built instance of SqlDatabase.