cognitoUserPoolClient.md

cognitoUserPoolClient Submodule

Constructs

CognitoUserPoolClient

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client aws_cognito_user_pool_client}.

Initializers

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

new cognitoUserPoolClient.CognitoUserPoolClient(scope: Construct, id: string, config: CognitoUserPoolClientConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	CognitoUserPoolClientConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: CognitoUserPoolClientConfig

---

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".
putAnalyticsConfiguration	No description.
putTokenValidityUnits	No description.
resetAccessTokenValidity	No description.
resetAllowedOauthFlows	No description.
resetAllowedOauthFlowsUserPoolClient	No description.
resetAllowedOauthScopes	No description.
resetAnalyticsConfiguration	No description.
resetCallbackUrls	No description.
resetDefaultRedirectUri	No description.
resetEnableTokenRevocation	No description.
resetExplicitAuthFlows	No description.
resetGenerateSecret	No description.
resetId	No description.
resetIdTokenValidity	No description.
resetLogoutUrls	No description.
resetPreventUserExistenceErrors	No description.
resetReadAttributes	No description.
resetRefreshTokenValidity	No description.
resetSupportedIdentityProviders	No description.
resetTokenValidityUnits	No description.
resetWriteAttributes	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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.

id^Required

• Type: string

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

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

putAnalyticsConfiguration

public putAnalyticsConfiguration(value: CognitoUserPoolClientAnalyticsConfiguration): void

value^Required

• Type: CognitoUserPoolClientAnalyticsConfiguration

---

putTokenValidityUnits

public putTokenValidityUnits(value: CognitoUserPoolClientTokenValidityUnits): void

value^Required

• Type: CognitoUserPoolClientTokenValidityUnits

---

resetAccessTokenValidity

public resetAccessTokenValidity(): void

resetAllowedOauthFlows

public resetAllowedOauthFlows(): void

resetAllowedOauthFlowsUserPoolClient

public resetAllowedOauthFlowsUserPoolClient(): void

resetAllowedOauthScopes

public resetAllowedOauthScopes(): void

resetAnalyticsConfiguration

public resetAnalyticsConfiguration(): void

resetCallbackUrls

public resetCallbackUrls(): void

resetDefaultRedirectUri

public resetDefaultRedirectUri(): void

resetEnableTokenRevocation

public resetEnableTokenRevocation(): void

resetExplicitAuthFlows

public resetExplicitAuthFlows(): void

resetGenerateSecret

public resetGenerateSecret(): void

resetId

public resetId(): void

resetIdTokenValidity

public resetIdTokenValidity(): void

resetLogoutUrls

public resetLogoutUrls(): void

resetPreventUserExistenceErrors

public resetPreventUserExistenceErrors(): void

resetReadAttributes

public resetReadAttributes(): void

resetRefreshTokenValidity

public resetRefreshTokenValidity(): void

resetSupportedIdentityProviders

public resetSupportedIdentityProviders(): void

resetTokenValidityUnits

public resetTokenValidityUnits(): void

resetWriteAttributes

public resetWriteAttributes(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a CognitoUserPoolClient resource upon running "cdktf plan ".

---

isConstruct

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

cognitoUserPoolClient.CognitoUserPoolClient.isConstruct(x: any)

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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

cognitoUserPoolClient.CognitoUserPoolClient.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

cognitoUserPoolClient.CognitoUserPoolClient.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

cognitoUserPoolClient.CognitoUserPoolClient.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing CognitoUserPoolClient that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
analyticsConfiguration	CognitoUserPoolClientAnalyticsConfigurationOutputReference	No description.
clientSecret	string	No description.
tokenValidityUnits	CognitoUserPoolClientTokenValidityUnitsOutputReference	No description.
accessTokenValidityInput	number	No description.
allowedOauthFlowsInput	string[]	No description.
allowedOauthFlowsUserPoolClientInput	boolean | cdktf.IResolvable	No description.
allowedOauthScopesInput	string[]	No description.
analyticsConfigurationInput	CognitoUserPoolClientAnalyticsConfiguration	No description.
callbackUrlsInput	string[]	No description.
defaultRedirectUriInput	string	No description.
enableTokenRevocationInput	boolean | cdktf.IResolvable	No description.
explicitAuthFlowsInput	string[]	No description.
generateSecretInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
idTokenValidityInput	number	No description.
logoutUrlsInput	string[]	No description.
nameInput	string	No description.
preventUserExistenceErrorsInput	string	No description.
readAttributesInput	string[]	No description.
refreshTokenValidityInput	number	No description.
supportedIdentityProvidersInput	string[]	No description.
tokenValidityUnitsInput	CognitoUserPoolClientTokenValidityUnits	No description.
userPoolIdInput	string	No description.
writeAttributesInput	string[]	No description.
accessTokenValidity	number	No description.
allowedOauthFlows	string[]	No description.
allowedOauthFlowsUserPoolClient	boolean | cdktf.IResolvable	No description.
allowedOauthScopes	string[]	No description.
callbackUrls	string[]	No description.
defaultRedirectUri	string	No description.
enableTokenRevocation	boolean | cdktf.IResolvable	No description.
explicitAuthFlows	string[]	No description.
generateSecret	boolean | cdktf.IResolvable	No description.
id	string	No description.
idTokenValidity	number	No description.
logoutUrls	string[]	No description.
name	string	No description.
preventUserExistenceErrors	string	No description.
readAttributes	string[]	No description.
refreshTokenValidity	number	No description.
supportedIdentityProviders	string[]	No description.
userPoolId	string	No description.
writeAttributes	string[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

analyticsConfiguration^Required

public readonly analyticsConfiguration: CognitoUserPoolClientAnalyticsConfigurationOutputReference;

• Type: CognitoUserPoolClientAnalyticsConfigurationOutputReference

---

clientSecret^Required

public readonly clientSecret: string;

• Type: string

---

tokenValidityUnits^Required

public readonly tokenValidityUnits: CognitoUserPoolClientTokenValidityUnitsOutputReference;

• Type: CognitoUserPoolClientTokenValidityUnitsOutputReference

---

accessTokenValidityInput^Optional

public readonly accessTokenValidityInput: number;

• Type: number

---

allowedOauthFlowsInput^Optional

public readonly allowedOauthFlowsInput: string[];

• Type: string[]

---

allowedOauthFlowsUserPoolClientInput^Optional

public readonly allowedOauthFlowsUserPoolClientInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

allowedOauthScopesInput^Optional

public readonly allowedOauthScopesInput: string[];

• Type: string[]

---

analyticsConfigurationInput^Optional

public readonly analyticsConfigurationInput: CognitoUserPoolClientAnalyticsConfiguration;

• Type: CognitoUserPoolClientAnalyticsConfiguration

---

callbackUrlsInput^Optional

public readonly callbackUrlsInput: string[];

• Type: string[]

---

defaultRedirectUriInput^Optional

public readonly defaultRedirectUriInput: string;

• Type: string

---

enableTokenRevocationInput^Optional

public readonly enableTokenRevocationInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

explicitAuthFlowsInput^Optional

public readonly explicitAuthFlowsInput: string[];

• Type: string[]

---

generateSecretInput^Optional

public readonly generateSecretInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

idTokenValidityInput^Optional

public readonly idTokenValidityInput: number;

• Type: number

---

logoutUrlsInput^Optional

public readonly logoutUrlsInput: string[];

• Type: string[]

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

preventUserExistenceErrorsInput^Optional

public readonly preventUserExistenceErrorsInput: string;

• Type: string

---

readAttributesInput^Optional

public readonly readAttributesInput: string[];

• Type: string[]

---

refreshTokenValidityInput^Optional

public readonly refreshTokenValidityInput: number;

• Type: number

---

supportedIdentityProvidersInput^Optional

public readonly supportedIdentityProvidersInput: string[];

• Type: string[]

---

tokenValidityUnitsInput^Optional

public readonly tokenValidityUnitsInput: CognitoUserPoolClientTokenValidityUnits;

• Type: CognitoUserPoolClientTokenValidityUnits

---

userPoolIdInput^Optional

public readonly userPoolIdInput: string;

• Type: string

---

writeAttributesInput^Optional

public readonly writeAttributesInput: string[];

• Type: string[]

---

accessTokenValidity^Required

public readonly accessTokenValidity: number;

• Type: number

---

allowedOauthFlows^Required

public readonly allowedOauthFlows: string[];

• Type: string[]

---

allowedOauthFlowsUserPoolClient^Required

public readonly allowedOauthFlowsUserPoolClient: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

allowedOauthScopes^Required

public readonly allowedOauthScopes: string[];

• Type: string[]

---

callbackUrls^Required

public readonly callbackUrls: string[];

• Type: string[]

---

defaultRedirectUri^Required

public readonly defaultRedirectUri: string;

• Type: string

---

enableTokenRevocation^Required

public readonly enableTokenRevocation: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

explicitAuthFlows^Required

public readonly explicitAuthFlows: string[];

• Type: string[]

---

generateSecret^Required

public readonly generateSecret: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

idTokenValidity^Required

public readonly idTokenValidity: number;

• Type: number

---

logoutUrls^Required

public readonly logoutUrls: string[];

• Type: string[]

---

name^Required

public readonly name: string;

• Type: string

---

preventUserExistenceErrors^Required

public readonly preventUserExistenceErrors: string;

• Type: string

---

readAttributes^Required

public readonly readAttributes: string[];

• Type: string[]

---

refreshTokenValidity^Required

public readonly refreshTokenValidity: number;

• Type: number

---

supportedIdentityProviders^Required

public readonly supportedIdentityProviders: string[];

• Type: string[]

---

userPoolId^Required

public readonly userPoolId: string;

• Type: string

---

writeAttributes^Required

public readonly writeAttributes: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

CognitoUserPoolClientAnalyticsConfiguration

Initializer

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

const cognitoUserPoolClientAnalyticsConfiguration: cognitoUserPoolClient.CognitoUserPoolClientAnalyticsConfiguration = { ... }

Properties

Name	Type	Description
applicationArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#application_arn CognitoUserPoolClient#application_arn}.
applicationId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#application_id CognitoUserPoolClient#application_id}.
externalId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#external_id CognitoUserPoolClient#external_id}.
roleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#role_arn CognitoUserPoolClient#role_arn}.
userDataShared	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#user_data_shared CognitoUserPoolClient#user_data_shared}.

---

applicationArn^Optional

public readonly applicationArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#application_arn CognitoUserPoolClient#application_arn}.

---

applicationId^Optional

public readonly applicationId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#application_id CognitoUserPoolClient#application_id}.

---

externalId^Optional

public readonly externalId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#external_id CognitoUserPoolClient#external_id}.

---

roleArn^Optional

public readonly roleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#role_arn CognitoUserPoolClient#role_arn}.

---

userDataShared^Optional

public readonly userDataShared: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#user_data_shared CognitoUserPoolClient#user_data_shared}.

---

CognitoUserPoolClientConfig

Initializer

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

const cognitoUserPoolClientConfig: cognitoUserPoolClient.CognitoUserPoolClientConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#name CognitoUserPoolClient#name}.
userPoolId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#user_pool_id CognitoUserPoolClient#user_pool_id}.
accessTokenValidity	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#access_token_validity CognitoUserPoolClient#access_token_validity}.
allowedOauthFlows	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_flows CognitoUserPoolClient#allowed_oauth_flows}.
allowedOauthFlowsUserPoolClient	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_flows_user_pool_client CognitoUserPoolClient#allowed_oauth_flows_user_pool_client}.
allowedOauthScopes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_scopes CognitoUserPoolClient#allowed_oauth_scopes}.
analyticsConfiguration	CognitoUserPoolClientAnalyticsConfiguration	analytics_configuration block.
callbackUrls	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#callback_urls CognitoUserPoolClient#callback_urls}.
defaultRedirectUri	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#default_redirect_uri CognitoUserPoolClient#default_redirect_uri}.
enableTokenRevocation	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#enable_token_revocation CognitoUserPoolClient#enable_token_revocation}.
explicitAuthFlows	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#explicit_auth_flows CognitoUserPoolClient#explicit_auth_flows}.
generateSecret	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#generate_secret CognitoUserPoolClient#generate_secret}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id CognitoUserPoolClient#id}.
idTokenValidity	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id_token_validity CognitoUserPoolClient#id_token_validity}.
logoutUrls	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#logout_urls CognitoUserPoolClient#logout_urls}.
preventUserExistenceErrors	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#prevent_user_existence_errors CognitoUserPoolClient#prevent_user_existence_errors}.
readAttributes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#read_attributes CognitoUserPoolClient#read_attributes}.
refreshTokenValidity	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#refresh_token_validity CognitoUserPoolClient#refresh_token_validity}.
supportedIdentityProviders	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#supported_identity_providers CognitoUserPoolClient#supported_identity_providers}.
tokenValidityUnits	CognitoUserPoolClientTokenValidityUnits	token_validity_units block.
writeAttributes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#write_attributes CognitoUserPoolClient#write_attributes}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#name CognitoUserPoolClient#name}.

---

userPoolId^Required

public readonly userPoolId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#user_pool_id CognitoUserPoolClient#user_pool_id}.

---

accessTokenValidity^Optional

public readonly accessTokenValidity: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#access_token_validity CognitoUserPoolClient#access_token_validity}.

---

allowedOauthFlows^Optional

public readonly allowedOauthFlows: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_flows CognitoUserPoolClient#allowed_oauth_flows}.

---

allowedOauthFlowsUserPoolClient^Optional

public readonly allowedOauthFlowsUserPoolClient: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_flows_user_pool_client CognitoUserPoolClient#allowed_oauth_flows_user_pool_client}.

---

allowedOauthScopes^Optional

public readonly allowedOauthScopes: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#allowed_oauth_scopes CognitoUserPoolClient#allowed_oauth_scopes}.

---

analyticsConfiguration^Optional

public readonly analyticsConfiguration: CognitoUserPoolClientAnalyticsConfiguration;

• Type: CognitoUserPoolClientAnalyticsConfiguration

analytics_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#analytics_configuration CognitoUserPoolClient#analytics_configuration}

---

callbackUrls^Optional

public readonly callbackUrls: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#callback_urls CognitoUserPoolClient#callback_urls}.

---

defaultRedirectUri^Optional

public readonly defaultRedirectUri: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#default_redirect_uri CognitoUserPoolClient#default_redirect_uri}.

---

enableTokenRevocation^Optional

public readonly enableTokenRevocation: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#enable_token_revocation CognitoUserPoolClient#enable_token_revocation}.

---

explicitAuthFlows^Optional

public readonly explicitAuthFlows: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#explicit_auth_flows CognitoUserPoolClient#explicit_auth_flows}.

---

generateSecret^Optional

public readonly generateSecret: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#generate_secret CognitoUserPoolClient#generate_secret}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id CognitoUserPoolClient#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.

---

idTokenValidity^Optional

public readonly idTokenValidity: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id_token_validity CognitoUserPoolClient#id_token_validity}.

---

logoutUrls^Optional

public readonly logoutUrls: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#logout_urls CognitoUserPoolClient#logout_urls}.

---

preventUserExistenceErrors^Optional

public readonly preventUserExistenceErrors: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#prevent_user_existence_errors CognitoUserPoolClient#prevent_user_existence_errors}.

---

readAttributes^Optional

public readonly readAttributes: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#read_attributes CognitoUserPoolClient#read_attributes}.

---

refreshTokenValidity^Optional

public readonly refreshTokenValidity: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#refresh_token_validity CognitoUserPoolClient#refresh_token_validity}.

---

supportedIdentityProviders^Optional

public readonly supportedIdentityProviders: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#supported_identity_providers CognitoUserPoolClient#supported_identity_providers}.

---

tokenValidityUnits^Optional

public readonly tokenValidityUnits: CognitoUserPoolClientTokenValidityUnits;

• Type: CognitoUserPoolClientTokenValidityUnits

token_validity_units block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#token_validity_units CognitoUserPoolClient#token_validity_units}

---

writeAttributes^Optional

public readonly writeAttributes: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#write_attributes CognitoUserPoolClient#write_attributes}.

---

CognitoUserPoolClientTokenValidityUnits

Initializer

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

const cognitoUserPoolClientTokenValidityUnits: cognitoUserPoolClient.CognitoUserPoolClientTokenValidityUnits = { ... }

Properties

Name	Type	Description
accessToken	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#access_token CognitoUserPoolClient#access_token}.
idToken	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id_token CognitoUserPoolClient#id_token}.
refreshToken	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#refresh_token CognitoUserPoolClient#refresh_token}.

---

accessToken^Optional

public readonly accessToken: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#access_token CognitoUserPoolClient#access_token}.

---

idToken^Optional

public readonly idToken: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#id_token CognitoUserPoolClient#id_token}.

---

refreshToken^Optional

public readonly refreshToken: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_user_pool_client#refresh_token CognitoUserPoolClient#refresh_token}.

---

Classes

CognitoUserPoolClientAnalyticsConfigurationOutputReference

Initializers

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

new cognitoUserPoolClient.CognitoUserPoolClientAnalyticsConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
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.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetApplicationArn	No description.
resetApplicationId	No description.
resetExternalId	No description.
resetRoleArn	No description.
resetUserDataShared	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetApplicationArn

public resetApplicationArn(): void

resetApplicationId

public resetApplicationId(): void

resetExternalId

public resetExternalId(): void

resetRoleArn

public resetRoleArn(): void

resetUserDataShared

public resetUserDataShared(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
applicationArnInput	string	No description.
applicationIdInput	string	No description.
externalIdInput	string	No description.
roleArnInput	string	No description.
userDataSharedInput	boolean | cdktf.IResolvable	No description.
applicationArn	string	No description.
applicationId	string	No description.
externalId	string	No description.
roleArn	string	No description.
userDataShared	boolean | cdktf.IResolvable	No description.
internalValue	CognitoUserPoolClientAnalyticsConfiguration	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

applicationArnInput^Optional

public readonly applicationArnInput: string;

• Type: string

---

applicationIdInput^Optional

public readonly applicationIdInput: string;

• Type: string

---

externalIdInput^Optional

public readonly externalIdInput: string;

• Type: string

---

roleArnInput^Optional

public readonly roleArnInput: string;

• Type: string

---

userDataSharedInput^Optional

public readonly userDataSharedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

applicationArn^Required

public readonly applicationArn: string;

• Type: string

---

applicationId^Required

public readonly applicationId: string;

• Type: string

---

externalId^Required

public readonly externalId: string;

• Type: string

---

roleArn^Required

public readonly roleArn: string;

• Type: string

---

userDataShared^Required

public readonly userDataShared: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: CognitoUserPoolClientAnalyticsConfiguration;

• Type: CognitoUserPoolClientAnalyticsConfiguration

---

CognitoUserPoolClientTokenValidityUnitsOutputReference

Initializers

import { cognitoUserPoolClient } from '@cdktf/aws-cdk'

new cognitoUserPoolClient.CognitoUserPoolClientTokenValidityUnitsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
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.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetAccessToken	No description.
resetIdToken	No description.
resetRefreshToken	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAccessToken

public resetAccessToken(): void

resetIdToken

public resetIdToken(): void

resetRefreshToken

public resetRefreshToken(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
accessTokenInput	string	No description.
idTokenInput	string	No description.
refreshTokenInput	string	No description.
accessToken	string	No description.
idToken	string	No description.
refreshToken	string	No description.
internalValue	CognitoUserPoolClientTokenValidityUnits	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

accessTokenInput^Optional

public readonly accessTokenInput: string;

• Type: string

---

idTokenInput^Optional

public readonly idTokenInput: string;

• Type: string

---

refreshTokenInput^Optional

public readonly refreshTokenInput: string;

• Type: string

---

accessToken^Required

public readonly accessToken: string;

• Type: string

---

idToken^Required

public readonly idToken: string;

• Type: string

---

refreshToken^Required

public readonly refreshToken: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: CognitoUserPoolClientTokenValidityUnits;

• Type: CognitoUserPoolClientTokenValidityUnits

---