Skip to content

Latest commit

 

History

History
1150 lines (716 loc) · 40.7 KB

mfaOkta.csharp.md

File metadata and controls

1150 lines (716 loc) · 40.7 KB
Raw

mfaOkta Submodule

Constructs

MfaOkta

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

Initializers 

using HashiCorp.Cdktf.Providers.Vault;

new MfaOkta(Construct Scope, string Id, MfaOktaConfig Config);
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 
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".

ResetBaseUrl 
private void ResetBaseUrl()
ResetId 
private void ResetId()
ResetNamespace 
private void ResetNamespace()
ResetPrimaryEmail 
private void ResetPrimaryEmail()
ResetUsernameFormat 
private void ResetUsernameFormat()

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 
using HashiCorp.Cdktf.Providers.Vault;

MfaOkta.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.Vault;

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

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

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

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.5.0/docs/resources/mfa_okta#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 MfaOkta 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.
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 object 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 object No description.
UsernameFormat 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[]
ApiTokenInputOptional 
public string ApiTokenInput { get; }
  • Type: string
BaseUrlInputOptional 
public string BaseUrlInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
MountAccessorInputOptional 
public string MountAccessorInput { get; }
  • Type: string
NameInputOptional 
public string NameInput { get; }
  • Type: string
NamespaceInputOptional 
public string NamespaceInput { get; }
  • Type: string
OrgNameInputOptional 
public string OrgNameInput { get; }
  • Type: string
PrimaryEmailInputOptional 
public object PrimaryEmailInput { get; }
  • Type: object
UsernameFormatInputOptional 
public string UsernameFormatInput { get; }
  • Type: string
ApiTokenRequired 
public string ApiToken { get; }
  • Type: string
BaseUrlRequired 
public string BaseUrl { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
MountAccessorRequired 
public string MountAccessor { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
NamespaceRequired 
public string Namespace { get; }
  • Type: string
OrgNameRequired 
public string OrgName { get; }
  • Type: string
PrimaryEmailRequired 
public object PrimaryEmail { get; }
  • Type: object
UsernameFormatRequired 
public string UsernameFormat { get; }
  • Type: string

Constants

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

Structs

MfaOktaConfig

Initializer 

using HashiCorp.Cdktf.Providers.Vault;

new MfaOktaConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ApiToken,
    string MountAccessor,
    string Name,
    string OrgName,
    string BaseUrl = null,
    string Id = null,
    string Namespace = null,
    object PrimaryEmail = null,
    string UsernameFormat = 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.
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 object 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 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[]
ApiTokenRequired 
public string ApiToken { get; set; }
  • Type: string

Okta API key.

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

MountAccessorRequired 
public string MountAccessor { get; set; }
  • 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.5.0/docs/resources/mfa_okta#mount_accessor MfaOkta#mount_accessor}

NameRequired 
public string Name { get; set; }
  • Type: string

Name of the MFA method.

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

OrgNameRequired 
public string OrgName { get; set; }
  • 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.5.0/docs/resources/mfa_okta#org_name MfaOkta#org_name}

BaseUrlOptional 
public string BaseUrl { get; set; }
  • 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.5.0/docs/resources/mfa_okta#base_url MfaOkta#base_url}

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

ID computed by Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.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 string Namespace { get; set; }
  • Type: string

Target namespace. (requires Enterprise).

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

PrimaryEmailOptional 
public object PrimaryEmail { get; set; }
  • Type: object

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.5.0/docs/resources/mfa_okta#primary_email MfaOkta#primary_email}

UsernameFormatOptional 
public string UsernameFormat { get; set; }
  • 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.5.0/docs/resources/mfa_okta#username_format MfaOkta#username_format}