Package com.hashicorp.cdktf.providers.google.sql_user

Class SqlUser.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<SqlUser>
    Enclosing class:
    SqlUser
    @Stability(Stable)
public static final class SqlUser.Builder
extends Object
implements software.amazon.jsii.Builder<SqlUser>
    A fluent builder for SqlUser.

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • instance

        @Stability(Stable)
public SqlUser.Builder instance​(String instance)
        The name of the Cloud SQL instance. Changing this forces a new resource to be created.

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

        Parameters:
        instance - The name of the Cloud SQL instance. Changing this forces a new resource to be created. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public SqlUser.Builder name​(String name)
        The name of the user. Changing this forces a new resource to be created.

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

        Parameters:
        name - The name of the user. Changing this forces a new resource to be created. This parameter is required.
        Returns:
        this

      • deletionPolicy

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

        Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for Postgres, where users cannot be deleted from the API if they have been granted SQL roles. Possible values are: "ABANDON". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#deletion_policy SqlUser#deletion_policy}

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

      • host

        @Stability(Stable)
public SqlUser.Builder host​(String host)
        The host the user can connect from.

        This is only supported for MySQL instances. Don't set this field for PostgreSQL instances. Can be an IP address. Changing this forces a new resource to be created. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#host SqlUser#host}

        Parameters:
        host - The host the user can connect from. This parameter is required.
        Returns:
        this

      • id

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

      • password

        @Stability(Stable)
public SqlUser.Builder password​(String password)
        The password for the user.

        Can be updated. For Postgres instances this is a Required field, unless type is set to either CLOUD_IAM_USER or CLOUD_IAM_SERVICE_ACCOUNT. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#password SqlUser#password}

        Parameters:
        password - The password for the user. This parameter is required.
        Returns:
        this

      • passwordPolicy

        @Stability(Stable)
public SqlUser.Builder passwordPolicy​(SqlUserPasswordPolicy passwordPolicy)
        password_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#password_policy SqlUser#password_policy}

        Parameters:
        passwordPolicy - password_policy block. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public SqlUser.Builder project​(String project)
        The ID of the project in which the resource belongs.

        If it is not provided, the provider project is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#project SqlUser#project}

        Parameters:
        project - The ID of the project in which the resource belongs. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public SqlUser.Builder timeouts​(SqlUserTimeouts timeouts)
        timeouts block.

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

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

      • type

        @Stability(Stable)
public SqlUser.Builder type​(String type)
        The user type.

        It determines the method to authenticate the user during login. The default is the database's built-in user type. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_user#type SqlUser#type}

        Parameters:
        type - The user type. This parameter is required.
        Returns:
        this

      • build

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