Skip to content

Latest commit

 

History

History
1403 lines (878 loc) · 53.5 KB

account.csharp.md

File metadata and controls

1403 lines (878 loc) · 53.5 KB

account Submodule

Constructs

Account

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account snowflake_account}.

Initializers

using HashiCorp.Cdktf.Providers.Snowflake;

new Account(Construct Scope, string Id, AccountConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config AccountConfig 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".
ResetAdminPassword No description.
ResetAdminRsaPublicKey No description.
ResetComment No description.
ResetFirstName No description.
ResetGracePeriodInDays No description.
ResetId No description.
ResetLastName No description.
ResetMustChangePassword No description.
ResetRegion No description.
ResetRegionGroup 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".


ResetAdminPassword
private void ResetAdminPassword()
ResetAdminRsaPublicKey
private void ResetAdminRsaPublicKey()
ResetComment
private void ResetComment()
ResetFirstName
private void ResetFirstName()
ResetGracePeriodInDays
private void ResetGracePeriodInDays()
ResetId
private void ResetId()
ResetLastName
private void ResetLastName()
ResetMustChangePassword
private void ResetMustChangePassword()
ResetRegion
private void ResetRegion()
ResetRegionGroup
private void ResetRegionGroup()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a Account resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Snowflake;

Account.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;

Account.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Snowflake;

Account.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Snowflake;

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

Generates CDKTF code for importing a Account 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 Account to import.


ImportFromIdRequired
  • Type: string

The id of the existing Account that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#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 Account 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.
FullyQualifiedName string No description.
IsOrgAdmin HashiCorp.Cdktf.IResolvable No description.
AdminNameInput string No description.
AdminPasswordInput string No description.
AdminRsaPublicKeyInput string No description.
CommentInput string No description.
EditionInput string No description.
EmailInput string No description.
FirstNameInput string No description.
GracePeriodInDaysInput double No description.
IdInput string No description.
LastNameInput string No description.
MustChangePasswordInput object No description.
NameInput string No description.
RegionGroupInput string No description.
RegionInput string No description.
AdminName string No description.
AdminPassword string No description.
AdminRsaPublicKey string No description.
Comment string No description.
Edition string No description.
Email string No description.
FirstName string No description.
GracePeriodInDays double No description.
Id string No description.
LastName string No description.
MustChangePassword object No description.
Name string No description.
Region string No description.
RegionGroup 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[]

FullyQualifiedNameRequired
public string FullyQualifiedName { get; }
  • Type: string

IsOrgAdminRequired
public IResolvable IsOrgAdmin { get; }
  • Type: HashiCorp.Cdktf.IResolvable

AdminNameInputOptional
public string AdminNameInput { get; }
  • Type: string

AdminPasswordInputOptional
public string AdminPasswordInput { get; }
  • Type: string

AdminRsaPublicKeyInputOptional
public string AdminRsaPublicKeyInput { get; }
  • Type: string

CommentInputOptional
public string CommentInput { get; }
  • Type: string

EditionInputOptional
public string EditionInput { get; }
  • Type: string

EmailInputOptional
public string EmailInput { get; }
  • Type: string

FirstNameInputOptional
public string FirstNameInput { get; }
  • Type: string

GracePeriodInDaysInputOptional
public double GracePeriodInDaysInput { get; }
  • Type: double

IdInputOptional
public string IdInput { get; }
  • Type: string

LastNameInputOptional
public string LastNameInput { get; }
  • Type: string

MustChangePasswordInputOptional
public object MustChangePasswordInput { get; }
  • Type: object

NameInputOptional
public string NameInput { get; }
  • Type: string

RegionGroupInputOptional
public string RegionGroupInput { get; }
  • Type: string

RegionInputOptional
public string RegionInput { get; }
  • Type: string

AdminNameRequired
public string AdminName { get; }
  • Type: string

AdminPasswordRequired
public string AdminPassword { get; }
  • Type: string

AdminRsaPublicKeyRequired
public string AdminRsaPublicKey { get; }
  • Type: string

CommentRequired
public string Comment { get; }
  • Type: string

EditionRequired
public string Edition { get; }
  • Type: string

EmailRequired
public string Email { get; }
  • Type: string

FirstNameRequired
public string FirstName { get; }
  • Type: string

GracePeriodInDaysRequired
public double GracePeriodInDays { get; }
  • Type: double

IdRequired
public string Id { get; }
  • Type: string

LastNameRequired
public string LastName { get; }
  • Type: string

MustChangePasswordRequired
public object MustChangePassword { get; }
  • Type: object

NameRequired
public string Name { get; }
  • Type: string

RegionRequired
public string Region { get; }
  • Type: string

RegionGroupRequired
public string RegionGroup { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

AccountConfig

Initializer

using HashiCorp.Cdktf.Providers.Snowflake;

new AccountConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string AdminName,
    string Edition,
    string Email,
    string Name,
    string AdminPassword = null,
    string AdminRsaPublicKey = null,
    string Comment = null,
    string FirstName = null,
    double GracePeriodInDays = null,
    string Id = null,
    string LastName = null,
    object MustChangePassword = null,
    string Region = null,
    string RegionGroup = 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.
AdminName string Login name of the initial administrative user of the account.
Edition string Snowflake Edition of the account. Valid values are: STANDARD | ENTERPRISE | BUSINESS_CRITICAL.
Email string Email address of the initial administrative user of the account.
Name string Specifies the identifier (i.e. name) for the account; must be unique within an organization, regardless of which Snowflake Region the account is in. In addition, the identifier must start with an alphabetic character and cannot contain spaces or special characters except for underscores (_). Note that if the account name includes underscores, features that do not accept account names with underscores (e.g. Okta SSO or SCIM) can reference a version of the account name that substitutes hyphens (-) for the underscores.
AdminPassword string Password for the initial administrative user of the account.
AdminRsaPublicKey string Assigns a public key to the initial administrative user of the account in order to implement key pair authentication for the user. Optional if the ADMIN_PASSWORD parameter is specified.
Comment string Specifies a comment for the account.
FirstName string First name of the initial administrative user of the account.
GracePeriodInDays double Specifies the number of days to wait before dropping the account. The default is 3 days.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#id Account#id}.
LastName string Last name of the initial administrative user of the account.
MustChangePassword object Specifies whether the new user created to administer the account is forced to change their password upon first login into the account.
Region string ID of the Snowflake Region where the account is created.
RegionGroup string ID of the Snowflake Region where the account is created.

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[]

AdminNameRequired
public string AdminName { get; set; }
  • Type: string

Login name of the initial administrative user of the account.

A new user is created in the new account with this name and password and granted the ACCOUNTADMIN role in the account. A login name can be any string consisting of letters, numbers, and underscores. Login names are always case-insensitive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#admin_name Account#admin_name}


EditionRequired
public string Edition { get; set; }
  • Type: string

Snowflake Edition of the account. Valid values are: STANDARD | ENTERPRISE | BUSINESS_CRITICAL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#edition Account#edition}


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

Email address of the initial administrative user of the account.

This email address is used to send any notifications about the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#email Account#email}


NameRequired
public string Name { get; set; }
  • Type: string

Specifies the identifier (i.e. name) for the account; must be unique within an organization, regardless of which Snowflake Region the account is in. In addition, the identifier must start with an alphabetic character and cannot contain spaces or special characters except for underscores (_). Note that if the account name includes underscores, features that do not accept account names with underscores (e.g. Okta SSO or SCIM) can reference a version of the account name that substitutes hyphens (-) for the underscores.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#name Account#name}


AdminPasswordOptional
public string AdminPassword { get; set; }
  • Type: string

Password for the initial administrative user of the account.

Optional if the ADMIN_RSA_PUBLIC_KEY parameter is specified. For more information about passwords in Snowflake, see Snowflake-provided Password Policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#admin_password Account#admin_password}


AdminRsaPublicKeyOptional
public string AdminRsaPublicKey { get; set; }
  • Type: string

Assigns a public key to the initial administrative user of the account in order to implement key pair authentication for the user. Optional if the ADMIN_PASSWORD parameter is specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#admin_rsa_public_key Account#admin_rsa_public_key}


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

Specifies a comment for the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#comment Account#comment}


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

First name of the initial administrative user of the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#first_name Account#first_name}


GracePeriodInDaysOptional
public double GracePeriodInDays { get; set; }
  • Type: double

Specifies the number of days to wait before dropping the account. The default is 3 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#grace_period_in_days Account#grace_period_in_days}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#id Account#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 initial administrative user of the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#last_name Account#last_name}


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

Specifies whether the new user created to administer the account is forced to change their password upon first login into the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#must_change_password Account#must_change_password}


RegionOptional
public string Region { get; set; }
  • Type: string

ID of the Snowflake Region where the account is created.

If no value is provided, Snowflake creates the account in the same Snowflake Region as the current account (i.e. the account in which the CREATE ACCOUNT statement is executed.)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#region Account#region}


RegionGroupOptional
public string RegionGroup { get; set; }
  • Type: string

ID of the Snowflake Region where the account is created.

If no value is provided, Snowflake creates the account in the same Snowflake Region as the current account (i.e. the account in which the CREATE ACCOUNT statement is executed.)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs/resources/account#region_group Account#region_group}