Skip to content

Latest commit

 

History

History
248 lines (147 loc) · 8.52 KB

README.md

File metadata and controls

248 lines (147 loc) · 8.52 KB

Snowflake::User::User

Allows for the creation and modification of a Snowflake User. https://docs.snowflake.com/en/user-guide/admin-user-management.html

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "Snowflake::User::User",
    "Properties" : {
        "Name" : String,
        "Password" : String,
        "LoginName" : String,
        "DisplayName" : String,
        "FirstName" : String,
        "MiddleName" : String,
        "LastName" : String,
        "Email" : String,
        "MustChangePassword" : Boolean,
        "Disabled" : Boolean,
        "DaysToExpiry" : Integer,
        "MinsToUnlock" : Integer,
        "DefaultWarehouse" : String,
        "DefaultRole" : String,
        "MinsToBypassMfa" : Integer,
        "RsaPublicKey" : String,
        "RsaPublicKey2" : String,
        "Comment" : String
    }
}

YAML

Type: Snowflake::User::User
Properties:
    Name: String
    Password: String
    LoginName: String
    DisplayName: String
    FirstName: String
    MiddleName: String
    LastName: String
    Email: String
    MustChangePassword: Boolean
    Disabled: Boolean
    DaysToExpiry: Integer
    MinsToUnlock: Integer
    DefaultWarehouse: String
    DefaultRole: String
    MinsToBypassMfa: Integer
    RsaPublicKey: String
    RsaPublicKey2: String
    Comment: String

Properties

Name

Identifier for the user; must be unique for your account.

Required: Yes

Type: String

Update requires: Replacement

Password

The password for the user

Required: Yes

Type: String

Update requires: No interruption

LoginName

Name that the user enters to log into the system. Login names for users must be unique across your entire account.

Required: No

Type: String

Update requires: No interruption

DisplayName

Name displayed for the user in the Snowflake web interface.

Required: No

Type: String

Update requires: No interruption

FirstName

First name of the user.

Required: No

Type: String

Update requires: No interruption

MiddleName

Middle name of the user.

Required: No

Type: String

Update requires: No interruption

LastName

Last name of the user.

Required: No

Type: String

Update requires: No interruption

Email

Email address for the user.

Required: No

Type: String

Update requires: No interruption

MustChangePassword

Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system.

Required: No

Type: Boolean

Update requires: No interruption

Disabled

Specifies whether the user is disabled.

Required: No

Type: Boolean

Update requires: No interruption

DaysToExpiry

Specifies the number of days after which the user status is set to Expired and the user is no longer allowed to log in.

Required: No

Type: Integer

Update requires: No interruption

MinsToUnlock

Specifies the number of minutes until the temporary lock on the user login is cleared.

Required: No

Type: Integer

Update requires: No interruption

DefaultWarehouse

Specifies the namespace (database only or database and schema) that is active by default for the user's session upon login.

Required: No

Type: String

Update requires: No interruption

DefaultRole

Specifies the primary role that is active by default for the user's session upon login.

Required: No

Type: String

Update requires: No interruption

MinsToBypassMfa

Specifies the number of minutes to temporarily bypass MFA for the user.

Required: No

Type: Integer

Update requires: No interruption

RsaPublicKey

Specifies the user's RSA public key; used for key pair authentication.

Required: No

Type: String

Update requires: No interruption

RsaPublicKey2

Specifies the user's second RSA public key; used to rotate the public and private keys for key pair authentication based on an expiration schedule set by your organization.

Required: No

Type: String

Update requires: No interruption

Comment

Specifies a comment for the user.

Required: No

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name.