1. Packages
  2. Google Cloud Native
  3. API Docs
  4. sqladmin
  5. sqladmin/v1beta4
  6. User

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.sqladmin/v1beta4.User

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new user in a Cloud SQL instance.

    Create User Resource

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             dual_password_type: Optional[UserDualPasswordType] = None,
             etag: Optional[str] = None,
             host: Optional[str] = None,
             instance: Optional[str] = None,
             kind: Optional[str] = None,
             name: Optional[str] = None,
             password: Optional[str] = None,
             password_policy: Optional[UserPasswordValidationPolicyArgs] = None,
             project: Optional[str] = None,
             sqlserver_user_details: Optional[SqlServerUserDetailsArgs] = None,
             type: Optional[UserType] = None)
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: google-native:sqladmin/v1beta4:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The User resource accepts the following input properties:

    Instance string
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    DualPasswordType Pulumi.GoogleNative.SQLAdmin.V1Beta4.UserDualPasswordType
    Dual password status for the user.
    Etag string
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    Host string
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    Kind string
    This is always sql#user.
    Name string
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    Password string
    The password for the user.
    PasswordPolicy Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.UserPasswordValidationPolicy
    User level password validation policy.
    Project string
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    SqlserverUserDetails Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.SqlServerUserDetails
    Type Pulumi.GoogleNative.SQLAdmin.V1Beta4.UserType
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
    Instance string
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    DualPasswordType UserDualPasswordType
    Dual password status for the user.
    Etag string
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    Host string
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    Kind string
    This is always sql#user.
    Name string
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    Password string
    The password for the user.
    PasswordPolicy UserPasswordValidationPolicyArgs
    User level password validation policy.
    Project string
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    SqlserverUserDetails SqlServerUserDetailsArgs
    Type UserType
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
    instance String
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    dualPasswordType UserDualPasswordType
    Dual password status for the user.
    etag String
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    host String
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    kind String
    This is always sql#user.
    name String
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    password String
    The password for the user.
    passwordPolicy UserPasswordValidationPolicy
    User level password validation policy.
    project String
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    sqlserverUserDetails SqlServerUserDetails
    type UserType
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
    instance string
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    dualPasswordType UserDualPasswordType
    Dual password status for the user.
    etag string
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    host string
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    kind string
    This is always sql#user.
    name string
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    password string
    The password for the user.
    passwordPolicy UserPasswordValidationPolicy
    User level password validation policy.
    project string
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    sqlserverUserDetails SqlServerUserDetails
    type UserType
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
    instance str
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    dual_password_type UserDualPasswordType
    Dual password status for the user.
    etag str
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    host str
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    kind str
    This is always sql#user.
    name str
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    password str
    The password for the user.
    password_policy UserPasswordValidationPolicyArgs
    User level password validation policy.
    project str
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    sqlserver_user_details SqlServerUserDetailsArgs
    type UserType
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
    instance String
    The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
    dualPasswordType "DUAL_PASSWORD_TYPE_UNSPECIFIED" | "NO_MODIFY_DUAL_PASSWORD" | "NO_DUAL_PASSWORD" | "DUAL_PASSWORD"
    Dual password status for the user.
    etag String
    This field is deprecated and will be removed from a future version of the API.

    Deprecated:This field is deprecated and will be removed from a future version of the API.

    host String
    Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
    kind String
    This is always sql#user.
    name String
    The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
    password String
    The password for the user.
    passwordPolicy Property Map
    User level password validation policy.
    project String
    The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
    sqlserverUserDetails Property Map
    type "BUILT_IN" | "CLOUD_IAM_USER" | "CLOUD_IAM_SERVICE_ACCOUNT" | "CLOUD_IAM_GROUP" | "CLOUD_IAM_GROUP_USER" | "CLOUD_IAM_GROUP_SERVICE_ACCOUNT"
    The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    PasswordStatusResponse, PasswordStatusResponseArgs

    Locked bool
    If true, user does not have login privileges.
    PasswordExpirationTime string
    The expiration time of the current password.
    Locked bool
    If true, user does not have login privileges.
    PasswordExpirationTime string
    The expiration time of the current password.
    locked Boolean
    If true, user does not have login privileges.
    passwordExpirationTime String
    The expiration time of the current password.
    locked boolean
    If true, user does not have login privileges.
    passwordExpirationTime string
    The expiration time of the current password.
    locked bool
    If true, user does not have login privileges.
    password_expiration_time str
    The expiration time of the current password.
    locked Boolean
    If true, user does not have login privileges.
    passwordExpirationTime String
    The expiration time of the current password.

    SqlServerUserDetails, SqlServerUserDetailsArgs

    Disabled bool
    If the user has been disabled
    ServerRoles List<string>
    The server roles for this user
    Disabled bool
    If the user has been disabled
    ServerRoles []string
    The server roles for this user
    disabled Boolean
    If the user has been disabled
    serverRoles List<String>
    The server roles for this user
    disabled boolean
    If the user has been disabled
    serverRoles string[]
    The server roles for this user
    disabled bool
    If the user has been disabled
    server_roles Sequence[str]
    The server roles for this user
    disabled Boolean
    If the user has been disabled
    serverRoles List<String>
    The server roles for this user

    SqlServerUserDetailsResponse, SqlServerUserDetailsResponseArgs

    Disabled bool
    If the user has been disabled
    ServerRoles List<string>
    The server roles for this user
    Disabled bool
    If the user has been disabled
    ServerRoles []string
    The server roles for this user
    disabled Boolean
    If the user has been disabled
    serverRoles List<String>
    The server roles for this user
    disabled boolean
    If the user has been disabled
    serverRoles string[]
    The server roles for this user
    disabled bool
    If the user has been disabled
    server_roles Sequence[str]
    The server roles for this user
    disabled Boolean
    If the user has been disabled
    serverRoles List<String>
    The server roles for this user

    UserDualPasswordType, UserDualPasswordTypeArgs

    DualPasswordTypeUnspecified
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    NoModifyDualPassword
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    NoDualPassword
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    DualPassword
    DUAL_PASSWORDDual password usable for connecting using this user.
    UserDualPasswordTypeDualPasswordTypeUnspecified
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    UserDualPasswordTypeNoModifyDualPassword
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    UserDualPasswordTypeNoDualPassword
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    UserDualPasswordTypeDualPassword
    DUAL_PASSWORDDual password usable for connecting using this user.
    DualPasswordTypeUnspecified
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    NoModifyDualPassword
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    NoDualPassword
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    DualPassword
    DUAL_PASSWORDDual password usable for connecting using this user.
    DualPasswordTypeUnspecified
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    NoModifyDualPassword
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    NoDualPassword
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    DualPassword
    DUAL_PASSWORDDual password usable for connecting using this user.
    DUAL_PASSWORD_TYPE_UNSPECIFIED
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    NO_MODIFY_DUAL_PASSWORD
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    NO_DUAL_PASSWORD
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    DUAL_PASSWORD
    DUAL_PASSWORDDual password usable for connecting using this user.
    "DUAL_PASSWORD_TYPE_UNSPECIFIED"
    DUAL_PASSWORD_TYPE_UNSPECIFIEDThe default value.
    "NO_MODIFY_DUAL_PASSWORD"
    NO_MODIFY_DUAL_PASSWORDDo not update the user's dual password status.
    "NO_DUAL_PASSWORD"
    NO_DUAL_PASSWORDNo dual password usable for connecting using this user.
    "DUAL_PASSWORD"
    DUAL_PASSWORDDual password usable for connecting using this user.

    UserPasswordValidationPolicy, UserPasswordValidationPolicyArgs

    AllowedFailedAttempts int
    Number of failed login attempts allowed before user get locked.
    EnableFailedAttemptsCheck bool
    If true, failed login attempts check will be enabled.
    EnablePasswordVerification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    PasswordExpirationDuration string
    Expiration duration after password is updated.
    AllowedFailedAttempts int
    Number of failed login attempts allowed before user get locked.
    EnableFailedAttemptsCheck bool
    If true, failed login attempts check will be enabled.
    EnablePasswordVerification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    PasswordExpirationDuration string
    Expiration duration after password is updated.
    allowedFailedAttempts Integer
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck Boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification Boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration String
    Expiration duration after password is updated.
    allowedFailedAttempts number
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration string
    Expiration duration after password is updated.
    allowed_failed_attempts int
    Number of failed login attempts allowed before user get locked.
    enable_failed_attempts_check bool
    If true, failed login attempts check will be enabled.
    enable_password_verification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    password_expiration_duration str
    Expiration duration after password is updated.
    allowedFailedAttempts Number
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck Boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification Boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration String
    Expiration duration after password is updated.

    UserPasswordValidationPolicyResponse, UserPasswordValidationPolicyResponseArgs

    AllowedFailedAttempts int
    Number of failed login attempts allowed before user get locked.
    EnableFailedAttemptsCheck bool
    If true, failed login attempts check will be enabled.
    EnablePasswordVerification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    PasswordExpirationDuration string
    Expiration duration after password is updated.
    Status Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.PasswordStatusResponse
    Read-only password status.
    AllowedFailedAttempts int
    Number of failed login attempts allowed before user get locked.
    EnableFailedAttemptsCheck bool
    If true, failed login attempts check will be enabled.
    EnablePasswordVerification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    PasswordExpirationDuration string
    Expiration duration after password is updated.
    Status PasswordStatusResponse
    Read-only password status.
    allowedFailedAttempts Integer
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck Boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification Boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration String
    Expiration duration after password is updated.
    status PasswordStatusResponse
    Read-only password status.
    allowedFailedAttempts number
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration string
    Expiration duration after password is updated.
    status PasswordStatusResponse
    Read-only password status.
    allowed_failed_attempts int
    Number of failed login attempts allowed before user get locked.
    enable_failed_attempts_check bool
    If true, failed login attempts check will be enabled.
    enable_password_verification bool
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    password_expiration_duration str
    Expiration duration after password is updated.
    status PasswordStatusResponse
    Read-only password status.
    allowedFailedAttempts Number
    Number of failed login attempts allowed before user get locked.
    enableFailedAttemptsCheck Boolean
    If true, failed login attempts check will be enabled.
    enablePasswordVerification Boolean
    If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
    passwordExpirationDuration String
    Expiration duration after password is updated.
    status Property Map
    Read-only password status.

    UserType, UserTypeArgs

    BuiltIn
    BUILT_INThe database's built-in user type.
    CloudIamUser
    CLOUD_IAM_USERCloud IAM user.
    CloudIamServiceAccount
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    CloudIamGroup
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    CloudIamGroupUser
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    CloudIamGroupServiceAccount
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.
    UserTypeBuiltIn
    BUILT_INThe database's built-in user type.
    UserTypeCloudIamUser
    CLOUD_IAM_USERCloud IAM user.
    UserTypeCloudIamServiceAccount
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    UserTypeCloudIamGroup
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    UserTypeCloudIamGroupUser
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    UserTypeCloudIamGroupServiceAccount
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.
    BuiltIn
    BUILT_INThe database's built-in user type.
    CloudIamUser
    CLOUD_IAM_USERCloud IAM user.
    CloudIamServiceAccount
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    CloudIamGroup
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    CloudIamGroupUser
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    CloudIamGroupServiceAccount
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.
    BuiltIn
    BUILT_INThe database's built-in user type.
    CloudIamUser
    CLOUD_IAM_USERCloud IAM user.
    CloudIamServiceAccount
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    CloudIamGroup
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    CloudIamGroupUser
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    CloudIamGroupServiceAccount
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.
    BUILT_IN
    BUILT_INThe database's built-in user type.
    CLOUD_IAM_USER
    CLOUD_IAM_USERCloud IAM user.
    CLOUD_IAM_SERVICE_ACCOUNT
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    CLOUD_IAM_GROUP
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    CLOUD_IAM_GROUP_USER
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    CLOUD_IAM_GROUP_SERVICE_ACCOUNT
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.
    "BUILT_IN"
    BUILT_INThe database's built-in user type.
    "CLOUD_IAM_USER"
    CLOUD_IAM_USERCloud IAM user.
    "CLOUD_IAM_SERVICE_ACCOUNT"
    CLOUD_IAM_SERVICE_ACCOUNTCloud IAM service account.
    "CLOUD_IAM_GROUP"
    CLOUD_IAM_GROUPCloud IAM Group non-login user.
    "CLOUD_IAM_GROUP_USER"
    CLOUD_IAM_GROUP_USERCloud IAM Group login user.
    "CLOUD_IAM_GROUP_SERVICE_ACCOUNT"
    CLOUD_IAM_GROUP_SERVICE_ACCOUNTCloud IAM Group service account.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi