Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user aws_cognito_user}.
using Io.Cdktn.Providers.Aws;
new CognitoUser(Construct Scope, string Id, CognitoUserConfig Config);| Name | Type | Description |
|---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
CognitoUserConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: CognitoUserConfig
| Name | Description |
|---|---|
ToString |
Returns a string representation of this construct. |
With |
Applies one or more mixins to 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". |
ResetAttributes |
No description. |
ResetClientMetadata |
No description. |
ResetDesiredDeliveryMediums |
No description. |
ResetEnabled |
No description. |
ResetForceAliasCreation |
No description. |
ResetId |
No description. |
ResetMessageAction |
No description. |
ResetPassword |
No description. |
ResetRegion |
No description. |
ResetTemporaryPassword |
No description. |
ResetValidationData |
No description. |
private string ToString()Returns a string representation of this construct.
private IConstruct With(params IMixin[] Mixins)Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
- Type: params Constructs.IMixin[]
The mixins to apply.
private void AddOverride(string Path, object Value)- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()private object ToMetadata()private object ToTerraform()Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)- Type: string
private string[] GetListAttribute(string TerraformAttribute)- Type: string
private double GetNumberAttribute(string TerraformAttribute)- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)- Type: string
private string GetStringAttribute(string TerraformAttribute)- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)- Type: string
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()private void ImportFrom(string Id, TerraformProvider Provider = null)- Type: string
- Type: Io.Cdktn.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, string|double Index = null)Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string|double
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetAttributes()private void ResetClientMetadata()private void ResetDesiredDeliveryMediums()private void ResetEnabled()private void ResetForceAliasCreation()private void ResetId()private void ResetMessageAction()private void ResetPassword()private void ResetRegion()private void ResetTemporaryPassword()private void ResetValidationData()| Name | Description |
|---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTN code for importing a CognitoUser resource upon running "cdktn plan ". |
using Io.Cdktn.Providers.Aws;
CognitoUser.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.
- Type: object
Any object.
using Io.Cdktn.Providers.Aws;
CognitoUser.IsTerraformElement(object X);- Type: object
using Io.Cdktn.Providers.Aws;
CognitoUser.IsTerraformResource(object X);- Type: object
using Io.Cdktn.Providers.Aws;
CognitoUser.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);Generates CDKTN code for importing a CognitoUser resource upon running "cdktn plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the CognitoUser to import.
- Type: string
The id of the existing CognitoUser that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#import import section} in the documentation of this resource for the id to use
- Type: Io.Cdktn.TerraformProvider
? Optional instance of the provider where the CognitoUser to import is found.
| Name | Type | Description |
|---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
Io.Cdktn.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 |
Io.Cdktn.TerraformProviderGeneratorMetadata |
No description. |
Connection |
Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection |
No description. |
Count |
double|Io.Cdktn.TerraformCount |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
Io.Cdktn.ITerraformIterator |
No description. |
Lifecycle |
Io.Cdktn.TerraformResourceLifecycle |
No description. |
Provider |
Io.Cdktn.TerraformProvider |
No description. |
Provisioners |
Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] |
No description. |
CreationDate |
string |
No description. |
LastModifiedDate |
string |
No description. |
MfaSettingList |
string[] |
No description. |
PreferredMfaSetting |
string |
No description. |
Status |
string |
No description. |
Sub |
string |
No description. |
AttributesInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
ClientMetadataInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
DesiredDeliveryMediumsInput |
string[] |
No description. |
EnabledInput |
bool|Io.Cdktn.IResolvable |
No description. |
ForceAliasCreationInput |
bool|Io.Cdktn.IResolvable |
No description. |
IdInput |
string |
No description. |
MessageActionInput |
string |
No description. |
PasswordInput |
string |
No description. |
RegionInput |
string |
No description. |
TemporaryPasswordInput |
string |
No description. |
UsernameInput |
string |
No description. |
UserPoolIdInput |
string |
No description. |
ValidationDataInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Attributes |
System.Collections.Generic.IDictionary<string, string> |
No description. |
ClientMetadata |
System.Collections.Generic.IDictionary<string, string> |
No description. |
DesiredDeliveryMediums |
string[] |
No description. |
Enabled |
bool|Io.Cdktn.IResolvable |
No description. |
ForceAliasCreation |
bool|Io.Cdktn.IResolvable |
No description. |
Id |
string |
No description. |
MessageAction |
string |
No description. |
Password |
string |
No description. |
Region |
string |
No description. |
TemporaryPassword |
string |
No description. |
Username |
string |
No description. |
UserPoolId |
string |
No description. |
ValidationData |
System.Collections.Generic.IDictionary<string, string> |
No description. |
public Node Node { get; }- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }- Type: Io.Cdktn.TerraformStack
public string Fqn { get; }- Type: string
public string FriendlyUniqueId { get; }- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }- Type: Io.Cdktn.TerraformProviderGeneratorMetadata
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }- Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
public double|TerraformCount Count { get; }- Type: double|Io.Cdktn.TerraformCount
public string[] DependsOn { get; }- Type: string[]
public ITerraformIterator ForEach { get; }- Type: Io.Cdktn.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }- Type: Io.Cdktn.TerraformResourceLifecycle
public TerraformProvider Provider { get; }- Type: Io.Cdktn.TerraformProvider
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }- Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
public string CreationDate { get; }- Type: string
public string LastModifiedDate { get; }- Type: string
public string[] MfaSettingList { get; }- Type: string[]
public string PreferredMfaSetting { get; }- Type: string
public string Status { get; }- Type: string
public string Sub { get; }- Type: string
public System.Collections.Generic.IDictionary<string, string> AttributesInput { get; }- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> ClientMetadataInput { get; }- Type: System.Collections.Generic.IDictionary<string, string>
public string[] DesiredDeliveryMediumsInput { get; }- Type: string[]
public bool|IResolvable EnabledInput { get; }- Type: bool|Io.Cdktn.IResolvable
public bool|IResolvable ForceAliasCreationInput { get; }- Type: bool|Io.Cdktn.IResolvable
public string IdInput { get; }- Type: string
public string MessageActionInput { get; }- Type: string
public string PasswordInput { get; }- Type: string
public string RegionInput { get; }- Type: string
public string TemporaryPasswordInput { get; }- Type: string
public string UsernameInput { get; }- Type: string
public string UserPoolIdInput { get; }- Type: string
public System.Collections.Generic.IDictionary<string, string> ValidationDataInput { get; }- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> Attributes { get; }- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> ClientMetadata { get; }- Type: System.Collections.Generic.IDictionary<string, string>
public string[] DesiredDeliveryMediums { get; }- Type: string[]
public bool|IResolvable Enabled { get; }- Type: bool|Io.Cdktn.IResolvable
public bool|IResolvable ForceAliasCreation { get; }- Type: bool|Io.Cdktn.IResolvable
public string Id { get; }- Type: string
public string MessageAction { get; }- Type: string
public string Password { get; }- Type: string
public string Region { get; }- Type: string
public string TemporaryPassword { get; }- Type: string
public string Username { get; }- Type: string
public string UserPoolId { get; }- Type: string
public System.Collections.Generic.IDictionary<string, string> ValidationData { get; }- Type: System.Collections.Generic.IDictionary<string, string>
| Name | Type | Description |
|---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }- Type: string
using Io.Cdktn.Providers.Aws;
new CognitoUserConfig {
SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
double|TerraformCount Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
(FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
string Username,
string UserPoolId,
System.Collections.Generic.IDictionary<string, string> Attributes = null,
System.Collections.Generic.IDictionary<string, string> ClientMetadata = null,
string[] DesiredDeliveryMediums = null,
bool|IResolvable Enabled = null,
bool|IResolvable ForceAliasCreation = null,
string Id = null,
string MessageAction = null,
string Password = null,
string Region = null,
string TemporaryPassword = null,
System.Collections.Generic.IDictionary<string, string> ValidationData = null
};| Name | Type | Description |
|---|---|---|
Connection |
Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection |
No description. |
Count |
double|Io.Cdktn.TerraformCount |
No description. |
DependsOn |
Io.Cdktn.ITerraformDependable[] |
No description. |
ForEach |
Io.Cdktn.ITerraformIterator |
No description. |
Lifecycle |
Io.Cdktn.TerraformResourceLifecycle |
No description. |
Provider |
Io.Cdktn.TerraformProvider |
No description. |
Provisioners |
Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] |
No description. |
Username |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#username CognitoUser#username}. |
UserPoolId |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}. |
Attributes |
System.Collections.Generic.IDictionary<string, string> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#attributes CognitoUser#attributes}. |
ClientMetadata |
System.Collections.Generic.IDictionary<string, string> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}. |
DesiredDeliveryMediums |
string[] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}. |
Enabled |
bool|Io.Cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#enabled CognitoUser#enabled}. |
ForceAliasCreation |
bool|Io.Cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#id CognitoUser#id}. |
MessageAction |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#message_action CognitoUser#message_action}. |
Password |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#password CognitoUser#password}. |
Region |
string |
Region where this resource will be managed. Defaults to the Region set in the provider configuration. |
TemporaryPassword |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}. |
ValidationData |
System.Collections.Generic.IDictionary<string, string> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}. |
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }- Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
public double|TerraformCount Count { get; set; }- Type: double|Io.Cdktn.TerraformCount
public ITerraformDependable[] DependsOn { get; set; }- Type: Io.Cdktn.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }- Type: Io.Cdktn.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }- Type: Io.Cdktn.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }- Type: Io.Cdktn.TerraformProvider
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }- Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
public string Username { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#username CognitoUser#username}.
public string UserPoolId { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}.
public System.Collections.Generic.IDictionary<string, string> Attributes { get; set; }- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#attributes CognitoUser#attributes}.
public System.Collections.Generic.IDictionary<string, string> ClientMetadata { get; set; }- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}.
public string[] DesiredDeliveryMediums { get; set; }- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}.
public bool|IResolvable Enabled { get; set; }- Type: bool|Io.Cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#enabled CognitoUser#enabled}.
public bool|IResolvable ForceAliasCreation { get; set; }- Type: bool|Io.Cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}.
public string Id { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#id CognitoUser#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.
public string MessageAction { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#message_action CognitoUser#message_action}.
public string Password { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#password CognitoUser#password}.
public string Region { get; set; }- Type: string
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#region CognitoUser#region}
public string TemporaryPassword { get; set; }- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}.
public System.Collections.Generic.IDictionary<string, string> ValidationData { get; set; }- Type: System.Collections.Generic.IDictionary<string, string>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}.