Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp okta_factor_totp}.
import { factorTotp } from '@cdktf/provider-okta'
new factorTotp.FactorTotp(scope: Construct, id: string, config: FactorTotpConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
FactorTotpConfig |
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: FactorTotpConfig
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". |
resetClockDriftInterval |
No description. |
resetHmacAlgorithm |
No description. |
resetId |
No description. |
resetOtpLength |
No description. |
resetSharedSecretEncoding |
No description. |
resetTimeStep |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
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 | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetClockDriftInterval(): void
public resetHmacAlgorithm(): void
public resetId(): void
public resetOtpLength(): void
public resetSharedSecretEncoding(): void
public resetTimeStep(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a FactorTotp resource upon running "cdktf plan ". |
import { factorTotp } from '@cdktf/provider-okta'
factorTotp.FactorTotp.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.
- Type: any
Any object.
import { factorTotp } from '@cdktf/provider-okta'
factorTotp.FactorTotp.isTerraformElement(x: any)
- Type: any
import { factorTotp } from '@cdktf/provider-okta'
factorTotp.FactorTotp.isTerraformResource(x: any)
- Type: any
import { factorTotp } from '@cdktf/provider-okta'
factorTotp.FactorTotp.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a FactorTotp resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the FactorTotp to import.
- Type: string
The id of the existing FactorTotp that should be imported.
Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the FactorTotp to import is found.
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. |
clockDriftIntervalInput |
number |
No description. |
hmacAlgorithmInput |
string |
No description. |
idInput |
string |
No description. |
nameInput |
string |
No description. |
otpLengthInput |
number |
No description. |
sharedSecretEncodingInput |
string |
No description. |
timeStepInput |
number |
No description. |
clockDriftInterval |
number |
No description. |
hmacAlgorithm |
string |
No description. |
id |
string |
No description. |
name |
string |
No description. |
otpLength |
number |
No description. |
sharedSecretEncoding |
string |
No description. |
timeStep |
number |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly clockDriftIntervalInput: number;
- Type: number
public readonly hmacAlgorithmInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly otpLengthInput: number;
- Type: number
public readonly sharedSecretEncodingInput: string;
- Type: string
public readonly timeStepInput: number;
- Type: number
public readonly clockDriftInterval: number;
- Type: number
public readonly hmacAlgorithm: string;
- Type: string
public readonly id: string;
- Type: string
public readonly name: string;
- Type: string
public readonly otpLength: number;
- Type: number
public readonly sharedSecretEncoding: string;
- Type: string
public readonly timeStep: number;
- Type: number
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { factorTotp } from '@cdktf/provider-okta'
const factorTotpConfig: factorTotp.FactorTotpConfig = { ... }
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 |
The TOTP name. |
clockDriftInterval |
number |
Clock drift interval. |
hmacAlgorithm |
string |
HMAC Algorithm. Valid values: HMacSHA1 , HMacSHA256 , HMacSHA512 . Default is HMacSHA512 . |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#id FactorTotp#id}. |
otpLength |
number |
Length of the password. Default is 6 . |
sharedSecretEncoding |
string |
Shared secret encoding. Valid values: base32 , base64 , hexadecimal . Default is base32 . |
timeStep |
number |
Time step in seconds. Valid values: 15 , 30 , 60 . Default is 15 . |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly name: string;
- Type: string
The TOTP name.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#name FactorTotp#name}
public readonly clockDriftInterval: number;
- Type: number
Clock drift interval.
This setting allows you to build in tolerance for any drift between the token's current time and the server's current time. Valid values: 3
, 5
, 10
. Default is 3
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#clock_drift_interval FactorTotp#clock_drift_interval}
public readonly hmacAlgorithm: string;
- Type: string
HMAC Algorithm. Valid values: HMacSHA1
, HMacSHA256
, HMacSHA512
. Default is HMacSHA512
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#hmac_algorithm FactorTotp#hmac_algorithm}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#id FactorTotp#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 readonly otpLength: number;
- Type: number
Length of the password. Default is 6
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#otp_length FactorTotp#otp_length}
public readonly sharedSecretEncoding: string;
- Type: string
Shared secret encoding. Valid values: base32
, base64
, hexadecimal
. Default is base32
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#shared_secret_encoding FactorTotp#shared_secret_encoding}
public readonly timeStep: number;
- Type: number
Time step in seconds. Valid values: 15
, 30
, 60
. Default is 15
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/factor_totp#time_step FactorTotp#time_step}