Skip to content

Latest commit

 

History

History
1526 lines (962 loc) · 68.5 KB

cognitoUser.java.md

File metadata and controls

1526 lines (962 loc) · 68.5 KB
Raw

cognitoUser Submodule

Constructs

CognitoUser

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user aws_cognito_user}.

Initializers 

import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUser;

CognitoUser.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .username(java.lang.String)
    .userPoolId(java.lang.String)
//  .attributes(java.util.Map<java.lang.String, java.lang.String>)
//  .clientMetadata(java.util.Map<java.lang.String, java.lang.String>)
//  .desiredDeliveryMediums(java.util.List<java.lang.String>)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .forceAliasCreation(java.lang.Boolean)
//  .forceAliasCreation(IResolvable)
//  .id(java.lang.String)
//  .messageAction(java.lang.String)
//  .password(java.lang.String)
//  .temporaryPassword(java.lang.String)
//  .validationData(java.util.Map<java.lang.String, java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
username java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#username CognitoUser#username}.
userPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}.
attributes java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#attributes CognitoUser#attributes}.
clientMetadata java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}.
desiredDeliveryMediums java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#enabled CognitoUser#enabled}.
forceAliasCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#id CognitoUser#id}.
messageAction java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#message_action CognitoUser#message_action}.
password java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#password CognitoUser#password}.
temporaryPassword java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}.
validationData java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
usernameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#username CognitoUser#username}.

userPoolIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}.

attributesOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#attributes CognitoUser#attributes}.

clientMetadataOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}.

desiredDeliveryMediumsOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}.

enabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#enabled CognitoUser#enabled}.

forceAliasCreationOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}.

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.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.

messageActionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#message_action CognitoUser#message_action}.

passwordOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#password CognitoUser#password}.

temporaryPasswordOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}.

validationDataOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}.

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".
resetAttributes No description.
resetClientMetadata No description.
resetDesiredDeliveryMediums No description.
resetEnabled No description.
resetForceAliasCreation No description.
resetId No description.
resetMessageAction No description.
resetPassword No description.
resetTemporaryPassword No description.
resetValidationData No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetAttributes 
public void resetAttributes()
resetClientMetadata 
public void resetClientMetadata()
resetDesiredDeliveryMediums 
public void resetDesiredDeliveryMediums()
resetEnabled 
public void resetEnabled()
resetForceAliasCreation 
public void resetForceAliasCreation()
resetId 
public void resetId()
resetMessageAction 
public void resetMessageAction()
resetPassword 
public void resetPassword()
resetTemporaryPassword 
public void resetTemporaryPassword()
resetValidationData 
public void resetValidationData()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a CognitoUser resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUser;

CognitoUser.isConstruct(java.lang.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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUser;

CognitoUser.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUser;

CognitoUser.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUser;

CognitoUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),CognitoUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing CognitoUser that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
creationDate java.lang.String No description.
lastModifiedDate java.lang.String No description.
mfaSettingList java.util.List<java.lang.String> No description.
preferredMfaSetting java.lang.String No description.
status java.lang.String No description.
sub java.lang.String No description.
attributesInput java.util.Map<java.lang.String, java.lang.String> No description.
clientMetadataInput java.util.Map<java.lang.String, java.lang.String> No description.
desiredDeliveryMediumsInput java.util.List<java.lang.String> No description.
enabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
forceAliasCreationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
messageActionInput java.lang.String No description.
passwordInput java.lang.String No description.
temporaryPasswordInput java.lang.String No description.
usernameInput java.lang.String No description.
userPoolIdInput java.lang.String No description.
validationDataInput java.util.Map<java.lang.String, java.lang.String> No description.
attributes java.util.Map<java.lang.String, java.lang.String> No description.
clientMetadata java.util.Map<java.lang.String, java.lang.String> No description.
desiredDeliveryMediums java.util.List<java.lang.String> No description.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
forceAliasCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
messageAction java.lang.String No description.
password java.lang.String No description.
temporaryPassword java.lang.String No description.
username java.lang.String No description.
userPoolId java.lang.String No description.
validationData java.util.Map<java.lang.String, java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
creationDateRequired 
public java.lang.String getCreationDate();
  • Type: java.lang.String
lastModifiedDateRequired 
public java.lang.String getLastModifiedDate();
  • Type: java.lang.String
mfaSettingListRequired 
public java.util.List<java.lang.String> getMfaSettingList();
  • Type: java.util.List<java.lang.String>
preferredMfaSettingRequired 
public java.lang.String getPreferredMfaSetting();
  • Type: java.lang.String
statusRequired 
public java.lang.String getStatus();
  • Type: java.lang.String
subRequired 
public java.lang.String getSub();
  • Type: java.lang.String
attributesInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getAttributesInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
clientMetadataInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getClientMetadataInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
desiredDeliveryMediumsInputOptional 
public java.util.List<java.lang.String> getDesiredDeliveryMediumsInput();
  • Type: java.util.List<java.lang.String>
enabledInputOptional 
public java.lang.Object getEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
forceAliasCreationInputOptional 
public java.lang.Object getForceAliasCreationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
messageActionInputOptional 
public java.lang.String getMessageActionInput();
  • Type: java.lang.String
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
temporaryPasswordInputOptional 
public java.lang.String getTemporaryPasswordInput();
  • Type: java.lang.String
usernameInputOptional 
public java.lang.String getUsernameInput();
  • Type: java.lang.String
userPoolIdInputOptional 
public java.lang.String getUserPoolIdInput();
  • Type: java.lang.String
validationDataInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getValidationDataInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
attributesRequired 
public java.util.Map<java.lang.String, java.lang.String> getAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.String>
clientMetadataRequired 
public java.util.Map<java.lang.String, java.lang.String> getClientMetadata();
  • Type: java.util.Map<java.lang.String, java.lang.String>
desiredDeliveryMediumsRequired 
public java.util.List<java.lang.String> getDesiredDeliveryMediums();
  • Type: java.util.List<java.lang.String>
enabledRequired 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
forceAliasCreationRequired 
public java.lang.Object getForceAliasCreation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
messageActionRequired 
public java.lang.String getMessageAction();
  • Type: java.lang.String
passwordRequired 
public java.lang.String getPassword();
  • Type: java.lang.String
temporaryPasswordRequired 
public java.lang.String getTemporaryPassword();
  • Type: java.lang.String
usernameRequired 
public java.lang.String getUsername();
  • Type: java.lang.String
userPoolIdRequired 
public java.lang.String getUserPoolId();
  • Type: java.lang.String
validationDataRequired 
public java.util.Map<java.lang.String, java.lang.String> getValidationData();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

CognitoUserConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.cognito_user.CognitoUserConfig;

CognitoUserConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .username(java.lang.String)
    .userPoolId(java.lang.String)
//  .attributes(java.util.Map<java.lang.String, java.lang.String>)
//  .clientMetadata(java.util.Map<java.lang.String, java.lang.String>)
//  .desiredDeliveryMediums(java.util.List<java.lang.String>)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .forceAliasCreation(java.lang.Boolean)
//  .forceAliasCreation(IResolvable)
//  .id(java.lang.String)
//  .messageAction(java.lang.String)
//  .password(java.lang.String)
//  .temporaryPassword(java.lang.String)
//  .validationData(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
username java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#username CognitoUser#username}.
userPoolId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}.
attributes java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#attributes CognitoUser#attributes}.
clientMetadata java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}.
desiredDeliveryMediums java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#enabled CognitoUser#enabled}.
forceAliasCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#id CognitoUser#id}.
messageAction java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#message_action CognitoUser#message_action}.
password java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#password CognitoUser#password}.
temporaryPassword java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}.
validationData java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
usernameRequired 
public java.lang.String getUsername();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#username CognitoUser#username}.

userPoolIdRequired 
public java.lang.String getUserPoolId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#user_pool_id CognitoUser#user_pool_id}.

attributesOptional 
public java.util.Map<java.lang.String, java.lang.String> getAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#attributes CognitoUser#attributes}.

clientMetadataOptional 
public java.util.Map<java.lang.String, java.lang.String> getClientMetadata();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#client_metadata CognitoUser#client_metadata}.

desiredDeliveryMediumsOptional 
public java.util.List<java.lang.String> getDesiredDeliveryMediums();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#desired_delivery_mediums CognitoUser#desired_delivery_mediums}.

enabledOptional 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#enabled CognitoUser#enabled}.

forceAliasCreationOptional 
public java.lang.Object getForceAliasCreation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#force_alias_creation CognitoUser#force_alias_creation}.

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.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.

messageActionOptional 
public java.lang.String getMessageAction();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#message_action CognitoUser#message_action}.

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#password CognitoUser#password}.

temporaryPasswordOptional 
public java.lang.String getTemporaryPassword();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#temporary_password CognitoUser#temporary_password}.

validationDataOptional 
public java.util.Map<java.lang.String, java.lang.String> getValidationData();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/cognito_user#validation_data CognitoUser#validation_data}.