Skip to content

Latest commit

 

History

History
1083 lines (669 loc) · 48.8 KB

policyDeviceAssuranceAndroid.typescript.md

File metadata and controls

1083 lines (669 loc) · 48.8 KB

policyDeviceAssuranceAndroid Submodule

Constructs

PolicyDeviceAssuranceAndroid

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android okta_policy_device_assurance_android}.

Initializers

import { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

new policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroid(scope: Construct, id: string, config: PolicyDeviceAssuranceAndroidConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config PolicyDeviceAssuranceAndroidConfig 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".
resetDiskEncryptionType No description.
resetJailbreak No description.
resetOsVersion No description.
resetScreenlockType No description.
resetSecureHardwarePresent 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".


resetDiskEncryptionType
public resetDiskEncryptionType(): void
resetJailbreak
public resetJailbreak(): void
resetOsVersion
public resetOsVersion(): void
resetScreenlockType
public resetScreenlockType(): void
resetSecureHardwarePresent
public resetSecureHardwarePresent(): 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 PolicyDeviceAssuranceAndroid resource upon running "cdktf plan ".

isConstruct
import { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroid.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 { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroid.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroid.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroid.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a PolicyDeviceAssuranceAndroid 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 PolicyDeviceAssuranceAndroid to import.


importFromIdRequired
  • Type: string

The id of the existing PolicyDeviceAssuranceAndroid that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#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 PolicyDeviceAssuranceAndroid 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.
createdBy string No description.
createdDate string No description.
id string No description.
lastUpdate string No description.
lastUpdatedBy string No description.
platform string No description.
diskEncryptionTypeInput string[] No description.
jailbreakInput boolean | cdktf.IResolvable No description.
nameInput string No description.
osVersionInput string No description.
screenlockTypeInput string[] No description.
secureHardwarePresentInput boolean | cdktf.IResolvable No description.
diskEncryptionType string[] No description.
jailbreak boolean | cdktf.IResolvable No description.
name string No description.
osVersion string No description.
screenlockType string[] No description.
secureHardwarePresent boolean | cdktf.IResolvable 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[]

createdByRequired
public readonly createdBy: string;
  • Type: string

createdDateRequired
public readonly createdDate: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

lastUpdateRequired
public readonly lastUpdate: string;
  • Type: string

lastUpdatedByRequired
public readonly lastUpdatedBy: string;
  • Type: string

platformRequired
public readonly platform: string;
  • Type: string

diskEncryptionTypeInputOptional
public readonly diskEncryptionTypeInput: string[];
  • Type: string[]

jailbreakInputOptional
public readonly jailbreakInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

nameInputOptional
public readonly nameInput: string;
  • Type: string

osVersionInputOptional
public readonly osVersionInput: string;
  • Type: string

screenlockTypeInputOptional
public readonly screenlockTypeInput: string[];
  • Type: string[]

secureHardwarePresentInputOptional
public readonly secureHardwarePresentInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

diskEncryptionTypeRequired
public readonly diskEncryptionType: string[];
  • Type: string[]

jailbreakRequired
public readonly jailbreak: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

nameRequired
public readonly name: string;
  • Type: string

osVersionRequired
public readonly osVersion: string;
  • Type: string

screenlockTypeRequired
public readonly screenlockType: string[];
  • Type: string[]

secureHardwarePresentRequired
public readonly secureHardwarePresent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

PolicyDeviceAssuranceAndroidConfig

Initializer

import { policyDeviceAssuranceAndroid } from '@cdktf/provider-okta'

const policyDeviceAssuranceAndroidConfig: policyDeviceAssuranceAndroid.PolicyDeviceAssuranceAndroidConfig = { ... }

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 Policy device assurance name.
diskEncryptionType string[] List of disk encryption type, can be FULL, USER.
jailbreak boolean | cdktf.IResolvable Is the device jailbroken in the device assurance policy.
osVersion string Minimum os version of the device in the device assurance policy.
screenlockType string[] List of screenlock type, can be BIOMETRIC or BIOMETRIC, PASSCODE.
secureHardwarePresent boolean | cdktf.IResolvable Indicates if the device contains a secure hardware functionality.

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[]

nameRequired
public readonly name: string;
  • Type: string

Policy device assurance name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#name PolicyDeviceAssuranceAndroid#name}


diskEncryptionTypeOptional
public readonly diskEncryptionType: string[];
  • Type: string[]

List of disk encryption type, can be FULL, USER.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#disk_encryption_type PolicyDeviceAssuranceAndroid#disk_encryption_type}


jailbreakOptional
public readonly jailbreak: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Is the device jailbroken in the device assurance policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#jailbreak PolicyDeviceAssuranceAndroid#jailbreak}


osVersionOptional
public readonly osVersion: string;
  • Type: string

Minimum os version of the device in the device assurance policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#os_version PolicyDeviceAssuranceAndroid#os_version}


screenlockTypeOptional
public readonly screenlockType: string[];
  • Type: string[]

List of screenlock type, can be BIOMETRIC or BIOMETRIC, PASSCODE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#screenlock_type PolicyDeviceAssuranceAndroid#screenlock_type}


secureHardwarePresentOptional
public readonly secureHardwarePresent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Indicates if the device contains a secure hardware functionality.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_device_assurance_android#secure_hardware_present PolicyDeviceAssuranceAndroid#secure_hardware_present}