policyRulePassword.csharp.md

policyRulePassword Submodule

Constructs

PolicyRulePassword

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

Initializers

using HashiCorp.Cdktf.Providers.Okta;

new PolicyRulePassword(Construct Scope, string Id, PolicyRulePasswordConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	PolicyRulePasswordConfig	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: PolicyRulePasswordConfig

---

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".
ResetId	No description.
ResetNetworkConnection	No description.
ResetNetworkExcludes	No description.
ResetNetworkIncludes	No description.
ResetPasswordChange	No description.
ResetPasswordReset	No description.
ResetPasswordUnlock	No description.
ResetPolicyId	No description.
ResetPriority	No description.
ResetStatus	No description.
ResetUsersExcluded	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

private void MoveTo(string MoveTarget, object Index = null)

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: object

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

---

MoveToId

private void MoveToId(string Id)

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

---

ResetId

private void ResetId()

ResetNetworkConnection

private void ResetNetworkConnection()

ResetNetworkExcludes

private void ResetNetworkExcludes()

ResetNetworkIncludes

private void ResetNetworkIncludes()

ResetPasswordChange

private void ResetPasswordChange()

ResetPasswordReset

private void ResetPasswordReset()

ResetPasswordUnlock

private void ResetPasswordUnlock()

ResetPolicyId

private void ResetPolicyId()

ResetPriority

private void ResetPriority()

ResetStatus

private void ResetStatus()

ResetUsersExcluded

private void ResetUsersExcluded()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformResource	No description.
GenerateConfigForImport	Generates CDKTF code for importing a PolicyRulePassword resource upon running "cdktf plan ".

---

IsConstruct

using HashiCorp.Cdktf.Providers.Okta;

PolicyRulePassword.IsConstruct(object X);

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: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Okta;

PolicyRulePassword.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Okta;

PolicyRulePassword.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Okta;

PolicyRulePassword.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

---

ImportFromId^Required

• Type: string

The id of the existing PolicyRulePassword that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
IdInput	string	No description.
NameInput	string	No description.
NetworkConnectionInput	string	No description.
NetworkExcludesInput	string[]	No description.
NetworkIncludesInput	string[]	No description.
PasswordChangeInput	string	No description.
PasswordResetInput	string	No description.
PasswordUnlockInput	string	No description.
PolicyIdInput	string	No description.
PriorityInput	double	No description.
StatusInput	string	No description.
UsersExcludedInput	string[]	No description.
Id	string	No description.
Name	string	No description.
NetworkConnection	string	No description.
NetworkExcludes	string[]	No description.
NetworkIncludes	string[]	No description.
PasswordChange	string	No description.
PasswordReset	string	No description.
PasswordUnlock	string	No description.
PolicyId	string	No description.
Priority	double	No description.
Status	string	No description.
UsersExcluded	string[]	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

NetworkConnectionInput^Optional

public string NetworkConnectionInput { get; }

• Type: string

---

NetworkExcludesInput^Optional

public string[] NetworkExcludesInput { get; }

• Type: string[]

---

NetworkIncludesInput^Optional

public string[] NetworkIncludesInput { get; }

• Type: string[]

---

PasswordChangeInput^Optional

public string PasswordChangeInput { get; }

• Type: string

---

PasswordResetInput^Optional

public string PasswordResetInput { get; }

• Type: string

---

PasswordUnlockInput^Optional

public string PasswordUnlockInput { get; }

• Type: string

---

PolicyIdInput^Optional

public string PolicyIdInput { get; }

• Type: string

---

PriorityInput^Optional

public double PriorityInput { get; }

• Type: double

---

StatusInput^Optional

public string StatusInput { get; }

• Type: string

---

UsersExcludedInput^Optional

public string[] UsersExcludedInput { get; }

• Type: string[]

---

Id^Required

public string Id { get; }

• Type: string

---

Name^Required

public string Name { get; }

• Type: string

---

NetworkConnection^Required

public string NetworkConnection { get; }

• Type: string

---

NetworkExcludes^Required

public string[] NetworkExcludes { get; }

• Type: string[]

---

NetworkIncludes^Required

public string[] NetworkIncludes { get; }

• Type: string[]

---

PasswordChange^Required

public string PasswordChange { get; }

• Type: string

---

PasswordReset^Required

public string PasswordReset { get; }

• Type: string

---

PasswordUnlock^Required

public string PasswordUnlock { get; }

• Type: string

---

PolicyId^Required

public string PolicyId { get; }

• Type: string

---

Priority^Required

public double Priority { get; }

• Type: double

---

Status^Required

public string Status { get; }

• Type: string

---

UsersExcluded^Required

public string[] UsersExcluded { get; }

• Type: string[]

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

PolicyRulePasswordConfig

Initializer

using HashiCorp.Cdktf.Providers.Okta;

new PolicyRulePasswordConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Id = null,
    string NetworkConnection = null,
    string[] NetworkExcludes = null,
    string[] NetworkIncludes = null,
    string PasswordChange = null,
    string PasswordReset = null,
    string PasswordUnlock = null,
    string PolicyId = null,
    double Priority = null,
    string Status = null,
    string[] UsersExcluded = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Name	string	Policy Rule Name.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#id PolicyRulePassword#id}.
NetworkConnection	string	Network selection mode: ANYWHERE, ZONE, ON_NETWORK, or OFF_NETWORK. Default: ANYWHERE.
NetworkExcludes	string[]	Required if network_connection = ZONE. Indicates the network zones to exclude.
NetworkIncludes	string[]	Required if network_connection = ZONE. Indicates the network zones to include.
PasswordChange	string	Allow or deny a user to change their password: ALLOW or DENY. Default: ALLOW.
PasswordReset	string	Allow or deny a user to reset their password: ALLOW or DENY. Default: ALLOW.
PasswordUnlock	string	Allow or deny a user to unlock. Default: DENY.
PolicyId	string	Policy ID of the Rule.
Priority	double	Rule priority.
Status	string	Policy Rule Status: ACTIVE or INACTIVE. Default: ACTIVE.
UsersExcluded	string[]	Set of User IDs to Exclude.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Name^Required

public string Name { get; set; }

• Type: string

Policy Rule Name.

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#id PolicyRulePassword#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.

---

NetworkConnection^Optional

public string NetworkConnection { get; set; }

• Type: string

Network selection mode: ANYWHERE, ZONE, ON_NETWORK, or OFF_NETWORK. Default: ANYWHERE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#network_connection PolicyRulePassword#network_connection}

---

NetworkExcludes^Optional

public string[] NetworkExcludes { get; set; }

• Type: string[]

Required if network_connection = ZONE. Indicates the network zones to exclude.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#network_excludes PolicyRulePassword#network_excludes}

---

NetworkIncludes^Optional

public string[] NetworkIncludes { get; set; }

• Type: string[]

Required if network_connection = ZONE. Indicates the network zones to include.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#network_includes PolicyRulePassword#network_includes}

---

PasswordChange^Optional

public string PasswordChange { get; set; }

• Type: string

Allow or deny a user to change their password: ALLOW or DENY. Default: ALLOW.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#password_change PolicyRulePassword#password_change}

---

PasswordReset^Optional

public string PasswordReset { get; set; }

• Type: string

Allow or deny a user to reset their password: ALLOW or DENY. Default: ALLOW.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#password_reset PolicyRulePassword#password_reset}

---

PasswordUnlock^Optional

public string PasswordUnlock { get; set; }

• Type: string

Allow or deny a user to unlock. Default: DENY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#password_unlock PolicyRulePassword#password_unlock}

---

PolicyId^Optional

public string PolicyId { get; set; }

• Type: string

Policy ID of the Rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#policy_id PolicyRulePassword#policy_id}

---

Priority^Optional

public double Priority { get; set; }

• Type: double

Rule priority.

This attribute can be set to a valid priority. To avoid an endless diff situation an error is thrown if an invalid property is provided. The Okta API defaults to the last (lowest) if not provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#priority PolicyRulePassword#priority}

---

Status^Optional

public string Status { get; set; }

• Type: string

Policy Rule Status: ACTIVE or INACTIVE. Default: ACTIVE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#status PolicyRulePassword#status}

---

UsersExcluded^Optional

public string[] UsersExcluded { get; set; }

• Type: string[]

Set of User IDs to Exclude.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/policy_rule_password#users_excluded PolicyRulePassword#users_excluded}

---