Skip to content

Latest commit

 

History

History
982 lines (617 loc) · 36.1 KB

dataOktaApp.csharp.md

File metadata and controls

982 lines (617 loc) · 36.1 KB

dataOktaApp Submodule

Constructs

DataOktaApp

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app okta_app}.

Initializers 

using HashiCorp.Cdktf.Providers.Okta;

new DataOktaApp(Construct Scope, string Id, DataOktaAppConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataOktaAppConfig 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

ConfigOptional

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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute No description.
ResetActiveOnly No description.
ResetId No description.
ResetLabel No description.
ResetLabelPrefix No description.
ResetSkipGroups No description.
ResetSkipUsers 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()

Adds this resource to the terraform JSON output.

ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

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
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
ResetActiveOnly 
private void ResetActiveOnly()
ResetId 
private void ResetId()
ResetLabel 
private void ResetLabel()
ResetLabelPrefix 
private void ResetLabelPrefix()
ResetSkipGroups 
private void ResetSkipGroups()
ResetSkipUsers 
private void ResetSkipUsers()

Static Functions

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

DataOktaApp.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;

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

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

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

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

ImportFromIdRequired
  • Type: string

The id of the existing DataOktaApp that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#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 DataOktaApp 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.
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.
Groups string[] No description.
Links string No description.
Name string No description.
Status string No description.
Users string[] No description.
ActiveOnlyInput object No description.
IdInput string No description.
LabelInput string No description.
LabelPrefixInput string No description.
SkipGroupsInput object No description.
SkipUsersInput object No description.
ActiveOnly object No description.
Id string No description.
Label string No description.
LabelPrefix string No description.
SkipGroups object No description.
SkipUsers object 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
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
GroupsRequired 
public string[] Groups { get; }
  • Type: string[]
LinksRequired 
public string Links { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
StatusRequired 
public string Status { get; }
  • Type: string
UsersRequired 
public string[] Users { get; }
  • Type: string[]
ActiveOnlyInputOptional 
public object ActiveOnlyInput { get; }
  • Type: object
IdInputOptional 
public string IdInput { get; }
  • Type: string
LabelInputOptional 
public string LabelInput { get; }
  • Type: string
LabelPrefixInputOptional 
public string LabelPrefixInput { get; }
  • Type: string
SkipGroupsInputOptional 
public object SkipGroupsInput { get; }
  • Type: object
SkipUsersInputOptional 
public object SkipUsersInput { get; }
  • Type: object
ActiveOnlyRequired 
public object ActiveOnly { get; }
  • Type: object
IdRequired 
public string Id { get; }
  • Type: string
LabelRequired 
public string Label { get; }
  • Type: string
LabelPrefixRequired 
public string LabelPrefix { get; }
  • Type: string
SkipGroupsRequired 
public object SkipGroups { get; }
  • Type: object
SkipUsersRequired 
public object SkipUsers { get; }
  • Type: object

Constants

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

Structs

DataOktaAppConfig

Initializer 

using HashiCorp.Cdktf.Providers.Okta;

new DataOktaAppConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    object ActiveOnly = null,
    string Id = null,
    string Label = null,
    string LabelPrefix = null,
    object SkipGroups = null,
    object SkipUsers = 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.
ActiveOnly object Search only ACTIVE applications.
Id string Id of application to retrieve, conflicts with label and label_prefix.
Label string The label of the app to retrieve, conflicts with label_prefix and id.
LabelPrefix string Label prefix of the app to retrieve, conflicts with label and id.
SkipGroups object Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.
SkipUsers object Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.
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[]
ActiveOnlyOptional 
public object ActiveOnly { get; set; }
  • Type: object

Search only ACTIVE applications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#active_only DataOktaApp#active_only}

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

Id of application to retrieve, conflicts with label and label_prefix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#id DataOktaApp#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.

LabelOptional 
public string Label { get; set; }
  • Type: string

The label of the app to retrieve, conflicts with label_prefix and id.

Label uses the ?q= query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#label DataOktaApp#label}

LabelPrefixOptional 
public string LabelPrefix { get; set; }
  • Type: string

Label prefix of the app to retrieve, conflicts with label and id.

This will tell the provider to do a starts with query as opposed to an equals query.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#label_prefix DataOktaApp#label_prefix}

SkipGroupsOptional 
public object SkipGroups { get; set; }
  • Type: object

Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#skip_groups DataOktaApp#skip_groups}

SkipUsersOptional 
public object SkipUsers { get; set; }
  • Type: object

Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/data-sources/app#skip_users DataOktaApp#skip_users}