Skip to content

Latest commit

 

History

History
1198 lines (757 loc) · 43.2 KB

provider.csharp.md

File metadata and controls

1198 lines (757 loc) · 43.2 KB
Raw

provider Submodule

Constructs

OktaProvider

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

Initializers 

using HashiCorp.Cdktf.Providers.Okta;

new OktaProvider(Construct Scope, string Id, OktaProviderConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config OktaProviderConfig 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 No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
ResetAccessToken No description.
ResetAlias No description.
ResetApiToken No description.
ResetBackoff No description.
ResetBaseUrl No description.
ResetClientId No description.
ResetHttpProxy No description.
ResetLogLevel No description.
ResetMaxApiCapacity No description.
ResetMaxRetries No description.
ResetMaxWaitSeconds No description.
ResetMinWaitSeconds No description.
ResetOrgName No description.
ResetParallelism No description.
ResetPrivateKey No description.
ResetPrivateKeyId No description.
ResetRequestTimeout No description.
ResetScopes 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.

ResetAccessToken 
private void ResetAccessToken()
ResetAlias 
private void ResetAlias()
ResetApiToken 
private void ResetApiToken()
ResetBackoff 
private void ResetBackoff()
ResetBaseUrl 
private void ResetBaseUrl()
ResetClientId 
private void ResetClientId()
ResetHttpProxy 
private void ResetHttpProxy()
ResetLogLevel 
private void ResetLogLevel()
ResetMaxApiCapacity 
private void ResetMaxApiCapacity()
ResetMaxRetries 
private void ResetMaxRetries()
ResetMaxWaitSeconds 
private void ResetMaxWaitSeconds()
ResetMinWaitSeconds 
private void ResetMinWaitSeconds()
ResetOrgName 
private void ResetOrgName()
ResetParallelism 
private void ResetParallelism()
ResetPrivateKey 
private void ResetPrivateKey()
ResetPrivateKeyId 
private void ResetPrivateKeyId()
ResetRequestTimeout 
private void ResetRequestTimeout()
ResetScopes 
private void ResetScopes()

Static Functions

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

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

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

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

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

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

ImportFromIdRequired
  • Type: string

The id of the existing OktaProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#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 OktaProvider 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.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AccessTokenInput string No description.
AliasInput string No description.
ApiTokenInput string No description.
BackoffInput object No description.
BaseUrlInput string No description.
ClientIdInput string No description.
HttpProxyInput string No description.
LogLevelInput double No description.
MaxApiCapacityInput double No description.
MaxRetriesInput double No description.
MaxWaitSecondsInput double No description.
MinWaitSecondsInput double No description.
OrgNameInput string No description.
ParallelismInput double No description.
PrivateKeyIdInput string No description.
PrivateKeyInput string No description.
RequestTimeoutInput double No description.
ScopesInput string[] No description.
AccessToken string No description.
ApiToken string No description.
Backoff object No description.
BaseUrl string No description.
ClientId string No description.
HttpProxy string No description.
LogLevel double No description.
MaxApiCapacity double No description.
MaxRetries double No description.
MaxWaitSeconds double No description.
MinWaitSeconds double No description.
OrgName string No description.
Parallelism double No description.
PrivateKey string No description.
PrivateKeyId string No description.
RequestTimeout double No description.
Scopes 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
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AccessTokenInputOptional 
public string AccessTokenInput { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
ApiTokenInputOptional 
public string ApiTokenInput { get; }
  • Type: string
BackoffInputOptional 
public object BackoffInput { get; }
  • Type: object
BaseUrlInputOptional 
public string BaseUrlInput { get; }
  • Type: string
ClientIdInputOptional 
public string ClientIdInput { get; }
  • Type: string
HttpProxyInputOptional 
public string HttpProxyInput { get; }
  • Type: string
LogLevelInputOptional 
public double LogLevelInput { get; }
  • Type: double
MaxApiCapacityInputOptional 
public double MaxApiCapacityInput { get; }
  • Type: double
MaxRetriesInputOptional 
public double MaxRetriesInput { get; }
  • Type: double
MaxWaitSecondsInputOptional 
public double MaxWaitSecondsInput { get; }
  • Type: double
MinWaitSecondsInputOptional 
public double MinWaitSecondsInput { get; }
  • Type: double
OrgNameInputOptional 
public string OrgNameInput { get; }
  • Type: string
ParallelismInputOptional 
public double ParallelismInput { get; }
  • Type: double
PrivateKeyIdInputOptional 
public string PrivateKeyIdInput { get; }
  • Type: string
PrivateKeyInputOptional 
public string PrivateKeyInput { get; }
  • Type: string
RequestTimeoutInputOptional 
public double RequestTimeoutInput { get; }
  • Type: double
ScopesInputOptional 
public string[] ScopesInput { get; }
  • Type: string[]
AccessTokenOptional 
public string AccessToken { get; }
  • Type: string
ApiTokenOptional 
public string ApiToken { get; }
  • Type: string
BackoffOptional 
public object Backoff { get; }
  • Type: object
BaseUrlOptional 
public string BaseUrl { get; }
  • Type: string
ClientIdOptional 
public string ClientId { get; }
  • Type: string
HttpProxyOptional 
public string HttpProxy { get; }
  • Type: string
LogLevelOptional 
public double LogLevel { get; }
  • Type: double
MaxApiCapacityOptional 
public double MaxApiCapacity { get; }
  • Type: double
MaxRetriesOptional 
public double MaxRetries { get; }
  • Type: double
MaxWaitSecondsOptional 
public double MaxWaitSeconds { get; }
  • Type: double
MinWaitSecondsOptional 
public double MinWaitSeconds { get; }
  • Type: double
OrgNameOptional 
public string OrgName { get; }
  • Type: string
ParallelismOptional 
public double Parallelism { get; }
  • Type: double
PrivateKeyOptional 
public string PrivateKey { get; }
  • Type: string
PrivateKeyIdOptional 
public string PrivateKeyId { get; }
  • Type: string
RequestTimeoutOptional 
public double RequestTimeout { get; }
  • Type: double
ScopesOptional 
public string[] Scopes { get; }
  • Type: string[]

Constants

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

Structs

OktaProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Okta;

new OktaProviderConfig {
    string AccessToken = null,
    string Alias = null,
    string ApiToken = null,
    object Backoff = null,
    string BaseUrl = null,
    string ClientId = null,
    string HttpProxy = null,
    double LogLevel = null,
    double MaxApiCapacity = null,
    double MaxRetries = null,
    double MaxWaitSeconds = null,
    double MinWaitSeconds = null,
    string OrgName = null,
    double Parallelism = null,
    string PrivateKey = null,
    string PrivateKeyId = null,
    double RequestTimeout = null,
    string[] Scopes = null
};

Properties

Name Type Description
AccessToken string Bearer token granting privileges to Okta API.
Alias string Alias name.
ApiToken string API Token granting privileges to Okta API.
Backoff object Use exponential back off strategy for rate limits.
BaseUrl string The Okta url. (Use 'oktapreview.com' for Okta testing).
ClientId string API Token granting privileges to Okta API.
HttpProxy string Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format.
LogLevel double providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR).
MaxApiCapacity double (Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints.
MaxRetries double maximum number of retries to attempt before erroring out.
MaxWaitSeconds double maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
MinWaitSeconds double minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
OrgName string The organization to manage in Okta.
Parallelism double Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://developer.okta.com/docs/api/getting_started/rate-limits.
PrivateKey string API Token granting privileges to Okta API.
PrivateKeyId string API Token Id granting privileges to Okta API.
RequestTimeout double Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set).
Scopes string[] API Token granting privileges to Okta API.
AccessTokenOptional 
public string AccessToken { get; set; }
  • Type: string

Bearer token granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#access_token OktaProvider#access_token}

AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#alias OktaProvider#alias}

ApiTokenOptional 
public string ApiToken { get; set; }
  • Type: string

API Token granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#api_token OktaProvider#api_token}

BackoffOptional 
public object Backoff { get; set; }
  • Type: object

Use exponential back off strategy for rate limits.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#backoff OktaProvider#backoff}

BaseUrlOptional 
public string BaseUrl { get; set; }
  • Type: string

The Okta url. (Use 'oktapreview.com' for Okta testing).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#base_url OktaProvider#base_url}

ClientIdOptional 
public string ClientId { get; set; }
  • Type: string

API Token granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#client_id OktaProvider#client_id}

HttpProxyOptional 
public string HttpProxy { get; set; }
  • Type: string

Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#http_proxy OktaProvider#http_proxy}

LogLevelOptional 
public double LogLevel { get; set; }
  • Type: double

providers log level. Minimum is 1 (TRACE), and maximum is 5 (ERROR).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#log_level OktaProvider#log_level}

MaxApiCapacityOptional 
public double MaxApiCapacity { get; set; }
  • Type: double

(Experimental) sets what percentage of capacity the provider can use of the total rate limit capacity while making calls to the Okta management API endpoints.

Okta API operates in one minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt/

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#max_api_capacity OktaProvider#max_api_capacity}

MaxRetriesOptional 
public double MaxRetries { get; set; }
  • Type: double

maximum number of retries to attempt before erroring out.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#max_retries OktaProvider#max_retries}

MaxWaitSecondsOptional 
public double MaxWaitSeconds { get; set; }
  • Type: double

maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#max_wait_seconds OktaProvider#max_wait_seconds}

MinWaitSecondsOptional 
public double MinWaitSeconds { get; set; }
  • Type: double

minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#min_wait_seconds OktaProvider#min_wait_seconds}

OrgNameOptional 
public string OrgName { get; set; }
  • Type: string

The organization to manage in Okta.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#org_name OktaProvider#org_name}

ParallelismOptional 
public double Parallelism { get; set; }
  • Type: double

Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://developer.okta.com/docs/api/getting_started/rate-limits.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#parallelism OktaProvider#parallelism}

PrivateKeyOptional 
public string PrivateKey { get; set; }
  • Type: string

API Token granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#private_key OktaProvider#private_key}

PrivateKeyIdOptional 
public string PrivateKeyId { get; set; }
  • Type: string

API Token Id granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#private_key_id OktaProvider#private_key_id}

RequestTimeoutOptional 
public double RequestTimeout { get; set; }
  • Type: double

Timeout for single request (in seconds) which is made to Okta, the default is 0 (means no limit is set).

The maximum value can be 300.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#request_timeout OktaProvider#request_timeout}

ScopesOptional 
public string[] Scopes { get; set; }
  • Type: string[]

API Token granting privileges to Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs#scopes OktaProvider#scopes}