Skip to content

Latest commit

 

History

History
1344 lines (841 loc) · 48.8 KB

password.csharp.md

File metadata and controls

1344 lines (841 loc) · 48.8 KB
Raw

password Submodule

Constructs

Password

Represents a {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password random_password}.

Initializers 

using HashiCorp.Cdktf.Providers.Random;

new Password(Construct Scope, string Id, PasswordConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config PasswordConfig 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".
ResetKeepers No description.
ResetLower No description.
ResetMinLower No description.
ResetMinNumeric No description.
ResetMinSpecial No description.
ResetMinUpper No description.
ResetNumber No description.
ResetNumeric No description.
ResetOverrideSpecial No description.
ResetSpecial No description.
ResetUpper 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".

ResetKeepers 
private void ResetKeepers()
ResetLower 
private void ResetLower()
ResetMinLower 
private void ResetMinLower()
ResetMinNumeric 
private void ResetMinNumeric()
ResetMinSpecial 
private void ResetMinSpecial()
ResetMinUpper 
private void ResetMinUpper()
ResetNumber 
private void ResetNumber()
ResetNumeric 
private void ResetNumeric()
ResetOverrideSpecial 
private void ResetOverrideSpecial()
ResetSpecial 
private void ResetSpecial()
ResetUpper 
private void ResetUpper()

Static Functions

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

Password.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.Random;

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

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

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

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

ImportFromIdRequired
  • Type: string

The id of the existing Password that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#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 Password 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.
BcryptHash string No description.
Id string No description.
Result string No description.
KeepersInput System.Collections.Generic.IDictionary<string, string> No description.
LengthInput double No description.
LowerInput object No description.
MinLowerInput double No description.
MinNumericInput double No description.
MinSpecialInput double No description.
MinUpperInput double No description.
NumberInput object No description.
NumericInput object No description.
OverrideSpecialInput string No description.
SpecialInput object No description.
UpperInput object No description.
Keepers System.Collections.Generic.IDictionary<string, string> No description.
Length double No description.
Lower object No description.
MinLower double No description.
MinNumeric double No description.
MinSpecial double No description.
MinUpper double No description.
Number object No description.
Numeric object No description.
OverrideSpecial string No description.
Special object No description.
Upper object 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[]
BcryptHashRequired 
public string BcryptHash { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
ResultRequired 
public string Result { get; }
  • Type: string
KeepersInputOptional 
public System.Collections.Generic.IDictionary<string, string> KeepersInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
LengthInputOptional 
public double LengthInput { get; }
  • Type: double
LowerInputOptional 
public object LowerInput { get; }
  • Type: object
MinLowerInputOptional 
public double MinLowerInput { get; }
  • Type: double
MinNumericInputOptional 
public double MinNumericInput { get; }
  • Type: double
MinSpecialInputOptional 
public double MinSpecialInput { get; }
  • Type: double
MinUpperInputOptional 
public double MinUpperInput { get; }
  • Type: double
NumberInputOptional 
public object NumberInput { get; }
  • Type: object
NumericInputOptional 
public object NumericInput { get; }
  • Type: object
OverrideSpecialInputOptional 
public string OverrideSpecialInput { get; }
  • Type: string
SpecialInputOptional 
public object SpecialInput { get; }
  • Type: object
UpperInputOptional 
public object UpperInput { get; }
  • Type: object
KeepersRequired 
public System.Collections.Generic.IDictionary<string, string> Keepers { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
LengthRequired 
public double Length { get; }
  • Type: double
LowerRequired 
public object Lower { get; }
  • Type: object
MinLowerRequired 
public double MinLower { get; }
  • Type: double
MinNumericRequired 
public double MinNumeric { get; }
  • Type: double
MinSpecialRequired 
public double MinSpecial { get; }
  • Type: double
MinUpperRequired 
public double MinUpper { get; }
  • Type: double
NumberRequired 
public object Number { get; }
  • Type: object
NumericRequired 
public object Numeric { get; }
  • Type: object
OverrideSpecialRequired 
public string OverrideSpecial { get; }
  • Type: string
SpecialRequired 
public object Special { get; }
  • Type: object
UpperRequired 
public object Upper { get; }
  • Type: object

Constants

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

Structs

PasswordConfig

Initializer 

using HashiCorp.Cdktf.Providers.Random;

new PasswordConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    double Length,
    System.Collections.Generic.IDictionary<string, string> Keepers = null,
    object Lower = null,
    double MinLower = null,
    double MinNumeric = null,
    double MinSpecial = null,
    double MinUpper = null,
    object Number = null,
    object Numeric = null,
    string OverrideSpecial = null,
    object Special = null,
    object Upper = 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.
Length double The length of the string desired.
Keepers System.Collections.Generic.IDictionary<string, string> Arbitrary map of values that, when changed, will trigger recreation of resource.
Lower object Include lowercase alphabet characters in the result. Default value is true.
MinLower double Minimum number of lowercase alphabet characters in the result. Default value is 0.
MinNumeric double Minimum number of numeric characters in the result. Default value is 0.
MinSpecial double Minimum number of special characters in the result. Default value is 0.
MinUpper double Minimum number of uppercase alphabet characters in the result. Default value is 0.
Number object Include numeric characters in the result.
Numeric object Include numeric characters in the result.
OverrideSpecial string Supply your own list of special characters to use for string generation.
Special object Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.
Upper object Include uppercase alphabet characters in the result. Default value is true.
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[]
LengthRequired 
public double Length { get; set; }
  • Type: double

The length of the string desired.

The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#length Password#length}

KeepersOptional 
public System.Collections.Generic.IDictionary<string, string> Keepers { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Arbitrary map of values that, when changed, will trigger recreation of resource.

See the main provider documentation for more information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#keepers Password#keepers}

LowerOptional 
public object Lower { get; set; }
  • Type: object

Include lowercase alphabet characters in the result. Default value is true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#lower Password#lower}

MinLowerOptional 
public double MinLower { get; set; }
  • Type: double

Minimum number of lowercase alphabet characters in the result. Default value is 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#min_lower Password#min_lower}

MinNumericOptional 
public double MinNumeric { get; set; }
  • Type: double

Minimum number of numeric characters in the result. Default value is 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#min_numeric Password#min_numeric}

MinSpecialOptional 
public double MinSpecial { get; set; }
  • Type: double

Minimum number of special characters in the result. Default value is 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#min_special Password#min_special}

MinUpperOptional 
public double MinUpper { get; set; }
  • Type: double

Minimum number of uppercase alphabet characters in the result. Default value is 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#min_upper Password#min_upper}

NumberOptional 
public object Number { get; set; }
  • Type: object

Include numeric characters in the result.

Default value is true. If number, upper, lower, and special are all configured, at least one of them must be set to true. NOTE: This is deprecated, use numeric instead.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#number Password#number}

NumericOptional 
public object Numeric { get; set; }
  • Type: object

Include numeric characters in the result.

Default value is true. If numeric, upper, lower, and special are all configured, at least one of them must be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#numeric Password#numeric}

OverrideSpecialOptional 
public string OverrideSpecial { get; set; }
  • Type: string

Supply your own list of special characters to use for string generation.

This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#override_special Password#override_special}

SpecialOptional 
public object Special { get; set; }
  • Type: object

Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#special Password#special}

UpperOptional 
public object Upper { get; set; }
  • Type: object

Include uppercase alphabet characters in the result. Default value is true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs/resources/password#upper Password#upper}