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

Interface SqlUserConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    SqlUserConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.814Z")
@Stability(Stable)
public interface SqlUserConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getInstance

        @Stability(Stable)
@NotNull
String getInstance()
        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}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getDeletionPolicy

        @Stability(Stable)
@Nullable
default String getDeletionPolicy()
        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}

      • getHost

        @Stability(Stable)
@Nullable
default String getHost()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getPassword

        @Stability(Stable)
@Nullable
default String getPassword()
        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}

      • getPasswordPolicy

        @Stability(Stable)
@Nullable
default SqlUserPasswordPolicy getPasswordPolicy()
        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}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default SqlUserTimeouts getTimeouts()
        timeouts block.

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

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        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}