Skip to content

Latest commit

 

History

History
1085 lines (675 loc) · 38.1 KB

appUser.csharp.md

File metadata and controls

1085 lines (675 loc) · 38.1 KB
Raw

appUser Submodule

Constructs

AppUser

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user okta_app_user}.

Initializers 

using HashiCorp.Cdktf.Providers.Okta;

new AppUser(Construct Scope, string Id, AppUserConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config AppUserConfig 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".
ResetId No description.
ResetPassword No description.
ResetProfile No description.
ResetRetainAssignment No description.
ResetUsername No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

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

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • 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.

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

MoveTargetRequired
  • Type: string

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

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

IdRequired
  • Type: string

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

ResetId 
private void ResetId()
ResetPassword 
private void ResetPassword()
ResetProfile 
private void ResetProfile()
ResetRetainAssignment 
private void ResetRetainAssignment()
ResetUsername 
private void ResetUsername()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a AppUser resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Okta;

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

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Okta;

AppUser.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Okta;

AppUser.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Okta;

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

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

ImportFromIdRequired
  • Type: string

The id of the existing AppUser that should be imported.

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

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the AppUser 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.
HasSharedUsername HashiCorp.Cdktf.IResolvable No description.
AppIdInput string No description.
IdInput string No description.
PasswordInput string No description.
ProfileInput string No description.
RetainAssignmentInput object No description.
UserIdInput string No description.
UsernameInput string No description.
AppId string No description.
Id string No description.
Password string No description.
Profile string No description.
RetainAssignment object No description.
UserId string No description.
Username string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
HasSharedUsernameRequired 
public IResolvable HasSharedUsername { get; }
  • Type: HashiCorp.Cdktf.IResolvable
AppIdInputOptional 
public string AppIdInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
PasswordInputOptional 
public string PasswordInput { get; }
  • Type: string
ProfileInputOptional 
public string ProfileInput { get; }
  • Type: string
RetainAssignmentInputOptional 
public object RetainAssignmentInput { get; }
  • Type: object
UserIdInputOptional 
public string UserIdInput { get; }
  • Type: string
UsernameInputOptional 
public string UsernameInput { get; }
  • Type: string
AppIdRequired 
public string AppId { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
PasswordRequired 
public string Password { get; }
  • Type: string
ProfileRequired 
public string Profile { get; }
  • Type: string
RetainAssignmentRequired 
public object RetainAssignment { get; }
  • Type: object
UserIdRequired 
public string UserId { get; }
  • Type: string
UsernameRequired 
public string Username { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

AppUserConfig

Initializer 

using HashiCorp.Cdktf.Providers.Okta;

new AppUserConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string AppId,
    string UserId,
    string Id = null,
    string Password = null,
    string Profile = null,
    object RetainAssignment = null,
    string Username = 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.
AppId string App to associate user with.
UserId string User associated with the application.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#id AppUser#id}.
Password string The password to use.
Profile string The JSON profile of the App User.
RetainAssignment object Retain the user assignment on destroy.
Username string The username to use for the app user.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
AppIdRequired 
public string AppId { get; set; }
  • Type: string

App to associate user with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#app_id AppUser#app_id}

UserIdRequired 
public string UserId { get; set; }
  • Type: string

User associated with the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#user_id AppUser#user_id}

IdOptional 
public string Id { get; set; }
  • Type: string

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

PasswordOptional 
public string Password { get; set; }
  • Type: string

The password to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#password AppUser#password}

ProfileOptional 
public string Profile { get; set; }
  • Type: string

The JSON profile of the App User.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#profile AppUser#profile}

RetainAssignmentOptional 
public object RetainAssignment { get; set; }
  • Type: object

Retain the user assignment on destroy.

If set to true, the resource will be removed from state but not from the Okta app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#retain_assignment AppUser#retain_assignment}

UsernameOptional 
public string Username { get; set; }
  • Type: string

The username to use for the app user.

In case the user is assigned to the app with SHARED_USERNAME_AND_PASSWORD credentials scheme, this field will be computed and should not be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/app_user#username AppUser#username}