Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property okta_app_user_base_schema_property}.
import { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
new appUserBaseSchemaProperty.AppUserBaseSchemaProperty(scope: Construct, id: string, config: AppUserBaseSchemaPropertyConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
AppUserBaseSchemaPropertyConfig |
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
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". |
resetId |
No description. |
resetMaster |
No description. |
resetPattern |
No description. |
resetPermissions |
No description. |
resetRequired |
No description. |
resetUserType |
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 resetId(): void
public resetMaster(): void
public resetPattern(): void
public resetPermissions(): void
public resetRequired(): void
public resetUserType(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a AppUserBaseSchemaProperty resource upon running "cdktf plan ". |
import { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
appUserBaseSchemaProperty.AppUserBaseSchemaProperty.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 { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
appUserBaseSchemaProperty.AppUserBaseSchemaProperty.isTerraformElement(x: any)
- Type: any
import { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
appUserBaseSchemaProperty.AppUserBaseSchemaProperty.isTerraformResource(x: any)
- Type: any
import { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
appUserBaseSchemaProperty.AppUserBaseSchemaProperty.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a AppUserBaseSchemaProperty 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 AppUserBaseSchemaProperty to import.
- Type: string
The id of the existing AppUserBaseSchemaProperty that should be imported.
Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the AppUserBaseSchemaProperty 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. |
appIdInput |
string |
No description. |
idInput |
string |
No description. |
indexInput |
string |
No description. |
masterInput |
string |
No description. |
patternInput |
string |
No description. |
permissionsInput |
string |
No description. |
requiredInput |
boolean | cdktf.IResolvable |
No description. |
titleInput |
string |
No description. |
typeInput |
string |
No description. |
userTypeInput |
string |
No description. |
appId |
string |
No description. |
id |
string |
No description. |
index |
string |
No description. |
master |
string |
No description. |
pattern |
string |
No description. |
permissions |
string |
No description. |
required |
boolean | cdktf.IResolvable |
No description. |
title |
string |
No description. |
type |
string |
No description. |
userType |
string |
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 appIdInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly indexInput: string;
- Type: string
public readonly masterInput: string;
- Type: string
public readonly patternInput: string;
- Type: string
public readonly permissionsInput: string;
- Type: string
public readonly requiredInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly titleInput: string;
- Type: string
public readonly typeInput: string;
- Type: string
public readonly userTypeInput: string;
- Type: string
public readonly appId: string;
- Type: string
public readonly id: string;
- Type: string
public readonly index: string;
- Type: string
public readonly master: string;
- Type: string
public readonly pattern: string;
- Type: string
public readonly permissions: string;
- Type: string
public readonly required: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly title: string;
- Type: string
public readonly type: string;
- Type: string
public readonly userType: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { appUserBaseSchemaProperty } from '@cdktf/provider-okta'
const appUserBaseSchemaPropertyConfig: appUserBaseSchemaProperty.AppUserBaseSchemaPropertyConfig = { ... }
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. |
appId |
string |
The Application's ID the user schema property should be assigned to. |
index |
string |
Subschema unique string identifier. |
title |
string |
Subschema title (display name). |
type |
string |
The type of the schema property. It can be string , boolean , number , integer , array , or object . |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#id AppUserBaseSchemaProperty#id}. |
master |
string |
Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA . Default: PROFILE_MASTER . |
pattern |
string |
The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'. |
permissions |
string |
Access control permissions for the property. It can be set to READ_WRITE , READ_ONLY , HIDE . Default: READ_ONLY . |
required |
boolean | cdktf.IResolvable |
Whether the subschema is required. |
userType |
string |
User type ID. By default, it is default . |
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 appId: string;
- Type: string
The Application's ID the user schema property should be assigned to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#app_id AppUserBaseSchemaProperty#app_id}
public readonly index: string;
- Type: string
Subschema unique string identifier.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#index AppUserBaseSchemaProperty#index}
public readonly title: string;
- Type: string
Subschema title (display name).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#title AppUserBaseSchemaProperty#title}
public readonly type: string;
- Type: string
The type of the schema property. It can be string
, boolean
, number
, integer
, array
, or object
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#type AppUserBaseSchemaProperty#type}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#id AppUserBaseSchemaProperty#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 master: string;
- Type: string
Master priority for the user schema property. It can be set to PROFILE_MASTER
or OKTA
. Default: PROFILE_MASTER
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#master AppUserBaseSchemaProperty#master}
public readonly pattern: string;
- Type: string
The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#pattern AppUserBaseSchemaProperty#pattern}
public readonly permissions: string;
- Type: string
Access control permissions for the property. It can be set to READ_WRITE
, READ_ONLY
, HIDE
. Default: READ_ONLY
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#permissions AppUserBaseSchemaProperty#permissions}
public readonly required: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Whether the subschema is required.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#required AppUserBaseSchemaProperty#required}
public readonly userType: string;
- Type: string
User type ID. By default, it is default
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_user_base_schema_property#user_type AppUserBaseSchemaProperty#user_type}