theme.csharp.md

theme Submodule

Constructs

Theme

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

Initializers

using HashiCorp.Cdktf.Providers.Okta;

new Theme(Construct Scope, string Id, ThemeConfig Config);

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

---

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".
ResetBackgroundImage	No description.
ResetEmailTemplateTouchPointVariant	No description.
ResetEndUserDashboardTouchPointVariant	No description.
ResetErrorPageTouchPointVariant	No description.
ResetFavicon	No description.
ResetLogo	No description.
ResetPrimaryColorContrastHex	No description.
ResetPrimaryColorHex	No description.
ResetSecondaryColorContrastHex	No description.
ResetSecondaryColorHex	No description.
ResetSignInPageTouchPointVariant	No description.
ResetThemeId	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".

---

ResetBackgroundImage

private void ResetBackgroundImage()

ResetEmailTemplateTouchPointVariant

private void ResetEmailTemplateTouchPointVariant()

ResetEndUserDashboardTouchPointVariant

private void ResetEndUserDashboardTouchPointVariant()

ResetErrorPageTouchPointVariant

private void ResetErrorPageTouchPointVariant()

ResetFavicon

private void ResetFavicon()

ResetLogo

private void ResetLogo()

ResetPrimaryColorContrastHex

private void ResetPrimaryColorContrastHex()

ResetPrimaryColorHex

private void ResetPrimaryColorHex()

ResetSecondaryColorContrastHex

private void ResetSecondaryColorContrastHex()

ResetSecondaryColorHex

private void ResetSecondaryColorHex()

ResetSignInPageTouchPointVariant

private void ResetSignInPageTouchPointVariant()

ResetThemeId

private void ResetThemeId()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Okta;

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

Theme.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Okta;

Theme.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Okta;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing Theme that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#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 Theme 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.
BackgroundImageUrl	string	No description.
FaviconUrl	string	No description.
Id	string	No description.
Links	string	No description.
LogoUrl	string	No description.
BackgroundImageInput	string	No description.
BrandIdInput	string	No description.
EmailTemplateTouchPointVariantInput	string	No description.
EndUserDashboardTouchPointVariantInput	string	No description.
ErrorPageTouchPointVariantInput	string	No description.
FaviconInput	string	No description.
LogoInput	string	No description.
PrimaryColorContrastHexInput	string	No description.
PrimaryColorHexInput	string	No description.
SecondaryColorContrastHexInput	string	No description.
SecondaryColorHexInput	string	No description.
SignInPageTouchPointVariantInput	string	No description.
ThemeIdInput	string	No description.
BackgroundImage	string	No description.
BrandId	string	No description.
EmailTemplateTouchPointVariant	string	No description.
EndUserDashboardTouchPointVariant	string	No description.
ErrorPageTouchPointVariant	string	No description.
Favicon	string	No description.
Logo	string	No description.
PrimaryColorContrastHex	string	No description.
PrimaryColorHex	string	No description.
SecondaryColorContrastHex	string	No description.
SecondaryColorHex	string	No description.
SignInPageTouchPointVariant	string	No description.
ThemeId	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[]

---

BackgroundImageUrl^Required

public string BackgroundImageUrl { get; }

• Type: string

---

FaviconUrl^Required

public string FaviconUrl { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Links^Required

public string Links { get; }

• Type: string

---

LogoUrl^Required

public string LogoUrl { get; }

• Type: string

---

BackgroundImageInput^Optional

public string BackgroundImageInput { get; }

• Type: string

---

BrandIdInput^Optional

public string BrandIdInput { get; }

• Type: string

---

EmailTemplateTouchPointVariantInput^Optional

public string EmailTemplateTouchPointVariantInput { get; }

• Type: string

---

EndUserDashboardTouchPointVariantInput^Optional

public string EndUserDashboardTouchPointVariantInput { get; }

• Type: string

---

ErrorPageTouchPointVariantInput^Optional

public string ErrorPageTouchPointVariantInput { get; }

• Type: string

---

FaviconInput^Optional

public string FaviconInput { get; }

• Type: string

---

LogoInput^Optional

public string LogoInput { get; }

• Type: string

---

PrimaryColorContrastHexInput^Optional

public string PrimaryColorContrastHexInput { get; }

• Type: string

---

PrimaryColorHexInput^Optional

public string PrimaryColorHexInput { get; }

• Type: string

---

SecondaryColorContrastHexInput^Optional

public string SecondaryColorContrastHexInput { get; }

• Type: string

---

SecondaryColorHexInput^Optional

public string SecondaryColorHexInput { get; }

• Type: string

---

SignInPageTouchPointVariantInput^Optional

public string SignInPageTouchPointVariantInput { get; }

• Type: string

---

ThemeIdInput^Optional

public string ThemeIdInput { get; }

• Type: string

---

BackgroundImage^Required

public string BackgroundImage { get; }

• Type: string

---

BrandId^Required

public string BrandId { get; }

• Type: string

---

EmailTemplateTouchPointVariant^Required

public string EmailTemplateTouchPointVariant { get; }

• Type: string

---

EndUserDashboardTouchPointVariant^Required

public string EndUserDashboardTouchPointVariant { get; }

• Type: string

---

ErrorPageTouchPointVariant^Required

public string ErrorPageTouchPointVariant { get; }

• Type: string

---

Favicon^Required

public string Favicon { get; }

• Type: string

---

Logo^Required

public string Logo { get; }

• Type: string

---

PrimaryColorContrastHex^Required

public string PrimaryColorContrastHex { get; }

• Type: string

---

PrimaryColorHex^Required

public string PrimaryColorHex { get; }

• Type: string

---

SecondaryColorContrastHex^Required

public string SecondaryColorContrastHex { get; }

• Type: string

---

SecondaryColorHex^Required

public string SecondaryColorHex { get; }

• Type: string

---

SignInPageTouchPointVariant^Required

public string SignInPageTouchPointVariant { get; }

• Type: string

---

ThemeId^Required

public string ThemeId { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ThemeConfig

Initializer

using HashiCorp.Cdktf.Providers.Okta;

new ThemeConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BrandId,
    string BackgroundImage = null,
    string EmailTemplateTouchPointVariant = null,
    string EndUserDashboardTouchPointVariant = null,
    string ErrorPageTouchPointVariant = null,
    string Favicon = null,
    string Logo = null,
    string PrimaryColorContrastHex = null,
    string PrimaryColorHex = null,
    string SecondaryColorContrastHex = null,
    string SecondaryColorHex = null,
    string SignInPageTouchPointVariant = null,
    string ThemeId = 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.
BrandId	string	Brand ID.
BackgroundImage	string	Path to local file.
EmailTemplateTouchPointVariant	string	Variant for email templates (OKTA_DEFAULT, FULL_THEME).
EndUserDashboardTouchPointVariant	string	Variant for the Okta End-User Dashboard (OKTA_DEFAULT, WHITE_LOGO_BACKGROUND, FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND).
ErrorPageTouchPointVariant	string	Variant for the error page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
Favicon	string	Path to local file.
Logo	string	Path to local file.
PrimaryColorContrastHex	string	Primary color contrast hex code.
PrimaryColorHex	string	Primary color hex code.
SecondaryColorContrastHex	string	Secondary color contrast hex code.
SecondaryColorHex	string	Secondary color hex code.
SignInPageTouchPointVariant	string	Variant for the Okta Sign-In Page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
ThemeId	string	Theme ID - Note: Okta API for theme only reads and updates therefore the okta_theme resource needs to act as a quasi data source.

---

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[]

---

BrandId^Required

public string BrandId { get; set; }

• Type: string

Brand ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#brand_id Theme#brand_id}

---

BackgroundImage^Optional

public string BackgroundImage { get; set; }

• Type: string

Path to local file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#background_image Theme#background_image}

---

EmailTemplateTouchPointVariant^Optional

public string EmailTemplateTouchPointVariant { get; set; }

• Type: string

Variant for email templates (OKTA_DEFAULT, FULL_THEME).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#email_template_touch_point_variant Theme#email_template_touch_point_variant}

---

EndUserDashboardTouchPointVariant^Optional

public string EndUserDashboardTouchPointVariant { get; set; }

• Type: string

Variant for the Okta End-User Dashboard (OKTA_DEFAULT, WHITE_LOGO_BACKGROUND, FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#end_user_dashboard_touch_point_variant Theme#end_user_dashboard_touch_point_variant}

---

ErrorPageTouchPointVariant^Optional

public string ErrorPageTouchPointVariant { get; set; }

• Type: string

Variant for the error page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#error_page_touch_point_variant Theme#error_page_touch_point_variant}

---

Favicon^Optional

public string Favicon { get; set; }

• Type: string

Path to local file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#favicon Theme#favicon}

---

Logo^Optional

public string Logo { get; set; }

• Type: string

Path to local file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#logo Theme#logo}

---

PrimaryColorContrastHex^Optional

public string PrimaryColorContrastHex { get; set; }

• Type: string

Primary color contrast hex code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#primary_color_contrast_hex Theme#primary_color_contrast_hex}

---

PrimaryColorHex^Optional

public string PrimaryColorHex { get; set; }

• Type: string

Primary color hex code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#primary_color_hex Theme#primary_color_hex}

---

SecondaryColorContrastHex^Optional

public string SecondaryColorContrastHex { get; set; }

• Type: string

Secondary color contrast hex code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#secondary_color_contrast_hex Theme#secondary_color_contrast_hex}

---

SecondaryColorHex^Optional

public string SecondaryColorHex { get; set; }

• Type: string

Secondary color hex code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#secondary_color_hex Theme#secondary_color_hex}

---

SignInPageTouchPointVariant^Optional

public string SignInPageTouchPointVariant { get; set; }

• Type: string

Variant for the Okta Sign-In Page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#sign_in_page_touch_point_variant Theme#sign_in_page_touch_point_variant}

---

ThemeId^Optional

public string ThemeId { get; set; }

• Type: string

Theme ID - Note: Okta API for theme only reads and updates therefore the okta_theme resource needs to act as a quasi data source.

Do this by setting theme_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/theme#theme_id Theme#theme_id}

---