Skip to content

Latest commit

 

History

History
1133 lines (699 loc) · 41.3 KB

mfaOkta.typescript.md

File metadata and controls

1133 lines (699 loc) · 41.3 KB
Raw

mfaOkta Submodule

Constructs

MfaOkta

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta vault_mfa_okta}.

Initializers 

import { mfaOkta } from '@cdktf/provider-vault'

new mfaOkta.MfaOkta(scope: Construct, id: string, config: MfaOktaConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config MfaOktaConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetBaseUrl No description.
resetId No description.
resetNamespace No description.
resetPrimaryEmail No description.
resetUsernameFormat No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

resetBaseUrl 
public resetBaseUrl(): void
resetId 
public resetId(): void
resetNamespace 
public resetNamespace(): void
resetPrimaryEmail 
public resetPrimaryEmail(): void
resetUsernameFormat 
public resetUsernameFormat(): 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 MfaOkta resource upon running "cdktf plan ".
isConstruct 
import { mfaOkta } from '@cdktf/provider-vault'

mfaOkta.MfaOkta.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { mfaOkta } from '@cdktf/provider-vault'

mfaOkta.MfaOkta.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { mfaOkta } from '@cdktf/provider-vault'

mfaOkta.MfaOkta.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { mfaOkta } from '@cdktf/provider-vault'

mfaOkta.MfaOkta.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing MfaOkta that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the MfaOkta 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.
apiTokenInput string No description.
baseUrlInput string No description.
idInput string No description.
mountAccessorInput string No description.
nameInput string No description.
namespaceInput string No description.
orgNameInput string No description.
primaryEmailInput boolean | cdktf.IResolvable No description.
usernameFormatInput string No description.
apiToken string No description.
baseUrl string No description.
id string No description.
mountAccessor string No description.
name string No description.
namespace string No description.
orgName string No description.
primaryEmail boolean | cdktf.IResolvable No description.
usernameFormat string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
apiTokenInputOptional 
public readonly apiTokenInput: string;
  • Type: string
baseUrlInputOptional 
public readonly baseUrlInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
mountAccessorInputOptional 
public readonly mountAccessorInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
namespaceInputOptional 
public readonly namespaceInput: string;
  • Type: string
orgNameInputOptional 
public readonly orgNameInput: string;
  • Type: string
primaryEmailInputOptional 
public readonly primaryEmailInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
usernameFormatInputOptional 
public readonly usernameFormatInput: string;
  • Type: string
apiTokenRequired 
public readonly apiToken: string;
  • Type: string
baseUrlRequired 
public readonly baseUrl: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
mountAccessorRequired 
public readonly mountAccessor: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
namespaceRequired 
public readonly namespace: string;
  • Type: string
orgNameRequired 
public readonly orgName: string;
  • Type: string
primaryEmailRequired 
public readonly primaryEmail: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
usernameFormatRequired 
public readonly usernameFormat: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

MfaOktaConfig

Initializer 

import { mfaOkta } from '@cdktf/provider-vault'

const mfaOktaConfig: mfaOkta.MfaOktaConfig = { ... }

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.
apiToken string Okta API key.
mountAccessor string The mount to tie this method to for use in automatic mappings.
name string Name of the MFA method.
orgName string Name of the organization to be used in the Okta API.
baseUrl string If set, will be used as the base domain for API requests.
id string ID computed by Vault.
namespace string Target namespace. (requires Enterprise).
primaryEmail boolean | cdktf.IResolvable If set to true, the username will only match the primary email for the account.
usernameFormat string A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
apiTokenRequired 
public readonly apiToken: string;
  • Type: string

Okta API key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#api_token MfaOkta#api_token}

mountAccessorRequired 
public readonly mountAccessor: string;
  • Type: string

The mount to tie this method to for use in automatic mappings.

The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#mount_accessor MfaOkta#mount_accessor}

nameRequired 
public readonly name: string;
  • Type: string

Name of the MFA method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#name MfaOkta#name}

orgNameRequired 
public readonly orgName: string;
  • Type: string

Name of the organization to be used in the Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#org_name MfaOkta#org_name}

baseUrlOptional 
public readonly baseUrl: string;
  • Type: string

If set, will be used as the base domain for API requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#base_url MfaOkta#base_url}

idOptional 
public readonly id: string;
  • Type: string

ID computed by Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#id MfaOkta#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.

namespaceOptional 
public readonly namespace: string;
  • Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#namespace MfaOkta#namespace}

primaryEmailOptional 
public readonly primaryEmail: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If set to true, the username will only match the primary email for the account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#primary_email MfaOkta#primary_email}

usernameFormatOptional 
public readonly usernameFormat: string;
  • Type: string

A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/mfa_okta#username_format MfaOkta#username_format}