Skip to content

Latest commit

 

History

History
1538 lines (968 loc) · 56 KB

user.csharp.md

File metadata and controls

1538 lines (968 loc) · 56 KB
Raw

user Submodule

Constructs

User

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user snowflake_user}.

Initializers 

using HashiCorp.Cdktf.Providers.Snowflake;

new User(Construct Scope, string Id, UserConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config UserConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetComment No description.
ResetDefaultNamespace No description.
ResetDefaultRole No description.
ResetDefaultSecondaryRoles No description.
ResetDefaultWarehouse No description.
ResetDisabled No description.
ResetDisplayName No description.
ResetEmail No description.
ResetFirstName No description.
ResetId No description.
ResetLastName No description.
ResetLoginName No description.
ResetMustChangePassword No description.
ResetPassword No description.
ResetRsaPublicKey No description.
ResetRsaPublicKey2 No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetComment 
private void ResetComment()
ResetDefaultNamespace 
private void ResetDefaultNamespace()
ResetDefaultRole 
private void ResetDefaultRole()
ResetDefaultSecondaryRoles 
private void ResetDefaultSecondaryRoles()
ResetDefaultWarehouse 
private void ResetDefaultWarehouse()
ResetDisabled 
private void ResetDisabled()
ResetDisplayName 
private void ResetDisplayName()
ResetEmail 
private void ResetEmail()
ResetFirstName 
private void ResetFirstName()
ResetId 
private void ResetId()
ResetLastName 
private void ResetLastName()
ResetLoginName 
private void ResetLoginName()
ResetMustChangePassword 
private void ResetMustChangePassword()
ResetPassword 
private void ResetPassword()
ResetRsaPublicKey 
private void ResetRsaPublicKey()
ResetRsaPublicKey2 
private void ResetRsaPublicKey2()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a User resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Snowflake;

User.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Snowflake;

User.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Snowflake;

User.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Snowflake;

User.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a User resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the User to import.

ImportFromIdRequired
  • Type: string

The id of the existing User that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the User to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
HasRsaPublicKey HashiCorp.Cdktf.IResolvable No description.
CommentInput string No description.
DefaultNamespaceInput string No description.
DefaultRoleInput string No description.
DefaultSecondaryRolesInput string[] No description.
DefaultWarehouseInput string No description.
DisabledInput object No description.
DisplayNameInput string No description.
EmailInput string No description.
FirstNameInput string No description.
IdInput string No description.
LastNameInput string No description.
LoginNameInput string No description.
MustChangePasswordInput object No description.
NameInput string No description.
PasswordInput string No description.
RsaPublicKey2Input string No description.
RsaPublicKeyInput string No description.
Comment string No description.
DefaultNamespace string No description.
DefaultRole string No description.
DefaultSecondaryRoles string[] No description.
DefaultWarehouse string No description.
Disabled object No description.
DisplayName string No description.
Email string No description.
FirstName string No description.
Id string No description.
LastName string No description.
LoginName string No description.
MustChangePassword object No description.
Name string No description.
Password string No description.
RsaPublicKey string No description.
RsaPublicKey2 string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
HasRsaPublicKeyRequired 
public IResolvable HasRsaPublicKey { get; }
  • Type: HashiCorp.Cdktf.IResolvable
CommentInputOptional 
public string CommentInput { get; }
  • Type: string
DefaultNamespaceInputOptional 
public string DefaultNamespaceInput { get; }
  • Type: string
DefaultRoleInputOptional 
public string DefaultRoleInput { get; }
  • Type: string
DefaultSecondaryRolesInputOptional 
public string[] DefaultSecondaryRolesInput { get; }
  • Type: string[]
DefaultWarehouseInputOptional 
public string DefaultWarehouseInput { get; }
  • Type: string
DisabledInputOptional 
public object DisabledInput { get; }
  • Type: object
DisplayNameInputOptional 
public string DisplayNameInput { get; }
  • Type: string
EmailInputOptional 
public string EmailInput { get; }
  • Type: string
FirstNameInputOptional 
public string FirstNameInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
LastNameInputOptional 
public string LastNameInput { get; }
  • Type: string
LoginNameInputOptional 
public string LoginNameInput { get; }
  • Type: string
MustChangePasswordInputOptional 
public object MustChangePasswordInput { get; }
  • Type: object
NameInputOptional 
public string NameInput { get; }
  • Type: string
PasswordInputOptional 
public string PasswordInput { get; }
  • Type: string
RsaPublicKey2InputOptional 
public string RsaPublicKey2Input { get; }
  • Type: string
RsaPublicKeyInputOptional 
public string RsaPublicKeyInput { get; }
  • Type: string
CommentRequired 
public string Comment { get; }
  • Type: string
DefaultNamespaceRequired 
public string DefaultNamespace { get; }
  • Type: string
DefaultRoleRequired 
public string DefaultRole { get; }
  • Type: string
DefaultSecondaryRolesRequired 
public string[] DefaultSecondaryRoles { get; }
  • Type: string[]
DefaultWarehouseRequired 
public string DefaultWarehouse { get; }
  • Type: string
DisabledRequired 
public object Disabled { get; }
  • Type: object
DisplayNameRequired 
public string DisplayName { get; }
  • Type: string
EmailRequired 
public string Email { get; }
  • Type: string
FirstNameRequired 
public string FirstName { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
LastNameRequired 
public string LastName { get; }
  • Type: string
LoginNameRequired 
public string LoginName { get; }
  • Type: string
MustChangePasswordRequired 
public object MustChangePassword { get; }
  • Type: object
NameRequired 
public string Name { get; }
  • Type: string
PasswordRequired 
public string Password { get; }
  • Type: string
RsaPublicKeyRequired 
public string RsaPublicKey { get; }
  • Type: string
RsaPublicKey2Required 
public string RsaPublicKey2 { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

UserConfig

Initializer 

using HashiCorp.Cdktf.Providers.Snowflake;

new UserConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Comment = null,
    string DefaultNamespace = null,
    string DefaultRole = null,
    string[] DefaultSecondaryRoles = null,
    string DefaultWarehouse = null,
    object Disabled = null,
    string DisplayName = null,
    string Email = null,
    string FirstName = null,
    string Id = null,
    string LastName = null,
    string LoginName = null,
    object MustChangePassword = null,
    string Password = null,
    string RsaPublicKey = null,
    string RsaPublicKey2 = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Name string Name of the user. Note that if you do not supply login_name this will be used as login_name. doc.
Comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#comment User#comment}.
DefaultNamespace string Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login.
DefaultRole string Specifies the role that is active by default for the user’s session upon login.
DefaultSecondaryRoles string[] Specifies the set of secondary roles that are active for the user’s session upon login.
DefaultWarehouse string Specifies the virtual warehouse that is active by default for the user’s session upon login.
Disabled object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#disabled User#disabled}.
DisplayName string Name displayed for the user in the Snowflake web interface.
Email string Email address for the user.
FirstName string First name of the user.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#id User#id}.
LastName string Last name of the user.
LoginName string The name users use to log in. If not supplied, snowflake will use name instead.
MustChangePassword object Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system.
Password string WARNING: this will put the password in the terraform state file. Use carefully.
RsaPublicKey string Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
RsaPublicKey2 string Specifies the user’s second RSA public key;
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
NameRequired 
public string Name { get; set; }
  • Type: string

Name of the user. Note that if you do not supply login_name this will be used as login_name. doc.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#name User#name}

CommentOptional 
public string Comment { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#comment User#comment}.

DefaultNamespaceOptional 
public string DefaultNamespace { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#default_namespace User#default_namespace}

DefaultRoleOptional 
public string DefaultRole { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#default_role User#default_role}

DefaultSecondaryRolesOptional 
public string[] DefaultSecondaryRoles { get; set; }
  • Type: string[]

Specifies the set of secondary roles that are active for the user’s session upon login.

Currently only ["ALL"] value is supported - more information can be found in doc

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#default_secondary_roles User#default_secondary_roles}

DefaultWarehouseOptional 
public string DefaultWarehouse { get; set; }
  • Type: string

Specifies the virtual warehouse that is active by default for the user’s session upon login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#default_warehouse User#default_warehouse}

DisabledOptional 
public object Disabled { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#disabled User#disabled}.

DisplayNameOptional 
public string DisplayName { get; set; }
  • Type: string

Name displayed for the user in the Snowflake web interface.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#display_name User#display_name}

EmailOptional 
public string Email { get; set; }
  • Type: string

Email address for the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#email User#email}

FirstNameOptional 
public string FirstName { get; set; }
  • Type: string

First name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#first_name User#first_name}

IdOptional 
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#id User#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.

LastNameOptional 
public string LastName { get; set; }
  • Type: string

Last name of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#last_name User#last_name}

LoginNameOptional 
public string LoginName { get; set; }
  • Type: string

The name users use to log in. If not supplied, snowflake will use name instead.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#login_name User#login_name}

MustChangePasswordOptional 
public object MustChangePassword { get; set; }
  • Type: object

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#must_change_password User#must_change_password}

PasswordOptional 
public string Password { get; set; }
  • Type: string

WARNING: this will put the password in the terraform state file. Use carefully.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#password User#password}

RsaPublicKeyOptional 
public string RsaPublicKey { get; set; }
  • Type: string

Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#rsa_public_key User#rsa_public_key}

RsaPublicKey2Optional 
public string RsaPublicKey2 { get; set; }
  • Type: string

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. Must be on 1 line without header and trailer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/user#rsa_public_key_2 User#rsa_public_key_2}