Skip to content

Latest commit

 

History

History
1621 lines (1014 loc) · 65.8 KB

theme.java.md

File metadata and controls

1621 lines (1014 loc) · 65.8 KB

theme Submodule

Constructs

Theme

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

Initializers 

import com.hashicorp.cdktf.providers.okta.theme.Theme;

Theme.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .brandId(java.lang.String)
//  .backgroundImage(java.lang.String)
//  .emailTemplateTouchPointVariant(java.lang.String)
//  .endUserDashboardTouchPointVariant(java.lang.String)
//  .errorPageTouchPointVariant(java.lang.String)
//  .favicon(java.lang.String)
//  .logo(java.lang.String)
//  .primaryColorContrastHex(java.lang.String)
//  .primaryColorHex(java.lang.String)
//  .secondaryColorContrastHex(java.lang.String)
//  .secondaryColorHex(java.lang.String)
//  .signInPageTouchPointVariant(java.lang.String)
//  .themeId(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
brandId java.lang.String Brand ID.
backgroundImage java.lang.String Path to local file.
emailTemplateTouchPointVariant java.lang.String Variant for email templates (OKTA_DEFAULT, FULL_THEME).
endUserDashboardTouchPointVariant java.lang.String Variant for the Okta End-User Dashboard (OKTA_DEFAULT, WHITE_LOGO_BACKGROUND, FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND).
errorPageTouchPointVariant java.lang.String Variant for the error page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
favicon java.lang.String Path to local file.
logo java.lang.String Path to local file.
primaryColorContrastHex java.lang.String Primary color contrast hex code.
primaryColorHex java.lang.String Primary color hex code.
secondaryColorContrastHex java.lang.String Secondary color contrast hex code.
secondaryColorHex java.lang.String Secondary color hex code.
signInPageTouchPointVariant java.lang.String Variant for the Okta Sign-In Page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
themeId java.lang.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.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
brandIdRequired
  • Type: java.lang.String

Brand ID.

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

backgroundImageOptional
  • Type: java.lang.String

Path to local file.

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

emailTemplateTouchPointVariantOptional
  • Type: java.lang.String

Variant for email templates (OKTA_DEFAULT, FULL_THEME).

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

endUserDashboardTouchPointVariantOptional
  • Type: java.lang.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.13.1/docs/resources/theme#end_user_dashboard_touch_point_variant Theme#end_user_dashboard_touch_point_variant}

errorPageTouchPointVariantOptional
  • Type: java.lang.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.13.1/docs/resources/theme#error_page_touch_point_variant Theme#error_page_touch_point_variant}

faviconOptional
  • Type: java.lang.String

Path to local file.

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

logoOptional
  • Type: java.lang.String

Path to local file.

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

primaryColorContrastHexOptional
  • Type: java.lang.String

Primary color contrast hex code.

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

primaryColorHexOptional
  • Type: java.lang.String

Primary color hex code.

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

secondaryColorContrastHexOptional
  • Type: java.lang.String

Secondary color contrast hex code.

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

secondaryColorHexOptional
  • Type: java.lang.String

Secondary color hex code.

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

signInPageTouchPointVariantOptional
  • Type: java.lang.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.13.1/docs/resources/theme#sign_in_page_touch_point_variant Theme#sign_in_page_touch_point_variant}

themeIdOptional
  • Type: java.lang.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.13.1/docs/resources/theme#theme_id Theme#theme_id}

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 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.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: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

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

resetBackgroundImage 
public void resetBackgroundImage()
resetEmailTemplateTouchPointVariant 
public void resetEmailTemplateTouchPointVariant()
resetEndUserDashboardTouchPointVariant 
public void resetEndUserDashboardTouchPointVariant()
resetErrorPageTouchPointVariant 
public void resetErrorPageTouchPointVariant()
resetFavicon 
public void resetFavicon()
resetLogo 
public void resetLogo()
resetPrimaryColorContrastHex 
public void resetPrimaryColorContrastHex()
resetPrimaryColorHex 
public void resetPrimaryColorHex()
resetSecondaryColorContrastHex 
public void resetSecondaryColorContrastHex()
resetSecondaryColorHex 
public void resetSecondaryColorHex()
resetSignInPageTouchPointVariant 
public void resetSignInPageTouchPointVariant()
resetThemeId 
public 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 
import com.hashicorp.cdktf.providers.okta.theme.Theme;

Theme.isConstruct(java.lang.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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.okta.theme.Theme;

Theme.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.okta.theme.Theme;

Theme.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.okta.theme.Theme;

Theme.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Theme.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a Theme resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the Theme to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing Theme that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the Theme to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
backgroundImageUrl java.lang.String No description.
faviconUrl java.lang.String No description.
id java.lang.String No description.
links java.lang.String No description.
logoUrl java.lang.String No description.
backgroundImageInput java.lang.String No description.
brandIdInput java.lang.String No description.
emailTemplateTouchPointVariantInput java.lang.String No description.
endUserDashboardTouchPointVariantInput java.lang.String No description.
errorPageTouchPointVariantInput java.lang.String No description.
faviconInput java.lang.String No description.
logoInput java.lang.String No description.
primaryColorContrastHexInput java.lang.String No description.
primaryColorHexInput java.lang.String No description.
secondaryColorContrastHexInput java.lang.String No description.
secondaryColorHexInput java.lang.String No description.
signInPageTouchPointVariantInput java.lang.String No description.
themeIdInput java.lang.String No description.
backgroundImage java.lang.String No description.
brandId java.lang.String No description.
emailTemplateTouchPointVariant java.lang.String No description.
endUserDashboardTouchPointVariant java.lang.String No description.
errorPageTouchPointVariant java.lang.String No description.
favicon java.lang.String No description.
logo java.lang.String No description.
primaryColorContrastHex java.lang.String No description.
primaryColorHex java.lang.String No description.
secondaryColorContrastHex java.lang.String No description.
secondaryColorHex java.lang.String No description.
signInPageTouchPointVariant java.lang.String No description.
themeId java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
backgroundImageUrlRequired 
public java.lang.String getBackgroundImageUrl();
  • Type: java.lang.String
faviconUrlRequired 
public java.lang.String getFaviconUrl();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
linksRequired 
public java.lang.String getLinks();
  • Type: java.lang.String
logoUrlRequired 
public java.lang.String getLogoUrl();
  • Type: java.lang.String
backgroundImageInputOptional 
public java.lang.String getBackgroundImageInput();
  • Type: java.lang.String
brandIdInputOptional 
public java.lang.String getBrandIdInput();
  • Type: java.lang.String
emailTemplateTouchPointVariantInputOptional 
public java.lang.String getEmailTemplateTouchPointVariantInput();
  • Type: java.lang.String
endUserDashboardTouchPointVariantInputOptional 
public java.lang.String getEndUserDashboardTouchPointVariantInput();
  • Type: java.lang.String
errorPageTouchPointVariantInputOptional 
public java.lang.String getErrorPageTouchPointVariantInput();
  • Type: java.lang.String
faviconInputOptional 
public java.lang.String getFaviconInput();
  • Type: java.lang.String
logoInputOptional 
public java.lang.String getLogoInput();
  • Type: java.lang.String
primaryColorContrastHexInputOptional 
public java.lang.String getPrimaryColorContrastHexInput();
  • Type: java.lang.String
primaryColorHexInputOptional 
public java.lang.String getPrimaryColorHexInput();
  • Type: java.lang.String
secondaryColorContrastHexInputOptional 
public java.lang.String getSecondaryColorContrastHexInput();
  • Type: java.lang.String
secondaryColorHexInputOptional 
public java.lang.String getSecondaryColorHexInput();
  • Type: java.lang.String
signInPageTouchPointVariantInputOptional 
public java.lang.String getSignInPageTouchPointVariantInput();
  • Type: java.lang.String
themeIdInputOptional 
public java.lang.String getThemeIdInput();
  • Type: java.lang.String
backgroundImageRequired 
public java.lang.String getBackgroundImage();
  • Type: java.lang.String
brandIdRequired 
public java.lang.String getBrandId();
  • Type: java.lang.String
emailTemplateTouchPointVariantRequired 
public java.lang.String getEmailTemplateTouchPointVariant();
  • Type: java.lang.String
endUserDashboardTouchPointVariantRequired 
public java.lang.String getEndUserDashboardTouchPointVariant();
  • Type: java.lang.String
errorPageTouchPointVariantRequired 
public java.lang.String getErrorPageTouchPointVariant();
  • Type: java.lang.String
faviconRequired 
public java.lang.String getFavicon();
  • Type: java.lang.String
logoRequired 
public java.lang.String getLogo();
  • Type: java.lang.String
primaryColorContrastHexRequired 
public java.lang.String getPrimaryColorContrastHex();
  • Type: java.lang.String
primaryColorHexRequired 
public java.lang.String getPrimaryColorHex();
  • Type: java.lang.String
secondaryColorContrastHexRequired 
public java.lang.String getSecondaryColorContrastHex();
  • Type: java.lang.String
secondaryColorHexRequired 
public java.lang.String getSecondaryColorHex();
  • Type: java.lang.String
signInPageTouchPointVariantRequired 
public java.lang.String getSignInPageTouchPointVariant();
  • Type: java.lang.String
themeIdRequired 
public java.lang.String getThemeId();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ThemeConfig

Initializer 

import com.hashicorp.cdktf.providers.okta.theme.ThemeConfig;

ThemeConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .brandId(java.lang.String)
//  .backgroundImage(java.lang.String)
//  .emailTemplateTouchPointVariant(java.lang.String)
//  .endUserDashboardTouchPointVariant(java.lang.String)
//  .errorPageTouchPointVariant(java.lang.String)
//  .favicon(java.lang.String)
//  .logo(java.lang.String)
//  .primaryColorContrastHex(java.lang.String)
//  .primaryColorHex(java.lang.String)
//  .secondaryColorContrastHex(java.lang.String)
//  .secondaryColorHex(java.lang.String)
//  .signInPageTouchPointVariant(java.lang.String)
//  .themeId(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
brandId java.lang.String Brand ID.
backgroundImage java.lang.String Path to local file.
emailTemplateTouchPointVariant java.lang.String Variant for email templates (OKTA_DEFAULT, FULL_THEME).
endUserDashboardTouchPointVariant java.lang.String Variant for the Okta End-User Dashboard (OKTA_DEFAULT, WHITE_LOGO_BACKGROUND, FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND).
errorPageTouchPointVariant java.lang.String Variant for the error page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
favicon java.lang.String Path to local file.
logo java.lang.String Path to local file.
primaryColorContrastHex java.lang.String Primary color contrast hex code.
primaryColorHex java.lang.String Primary color hex code.
secondaryColorContrastHex java.lang.String Secondary color contrast hex code.
secondaryColorHex java.lang.String Secondary color hex code.
signInPageTouchPointVariant java.lang.String Variant for the Okta Sign-In Page (OKTA_DEFAULT, BACKGROUND_SECONDARY_COLOR, BACKGROUND_IMAGE).
themeId java.lang.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.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
brandIdRequired 
public java.lang.String getBrandId();
  • Type: java.lang.String

Brand ID.

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

backgroundImageOptional 
public java.lang.String getBackgroundImage();
  • Type: java.lang.String

Path to local file.

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

emailTemplateTouchPointVariantOptional 
public java.lang.String getEmailTemplateTouchPointVariant();
  • Type: java.lang.String

Variant for email templates (OKTA_DEFAULT, FULL_THEME).

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

endUserDashboardTouchPointVariantOptional 
public java.lang.String getEndUserDashboardTouchPointVariant();
  • Type: java.lang.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.13.1/docs/resources/theme#end_user_dashboard_touch_point_variant Theme#end_user_dashboard_touch_point_variant}

errorPageTouchPointVariantOptional 
public java.lang.String getErrorPageTouchPointVariant();
  • Type: java.lang.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.13.1/docs/resources/theme#error_page_touch_point_variant Theme#error_page_touch_point_variant}

faviconOptional 
public java.lang.String getFavicon();
  • Type: java.lang.String

Path to local file.

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

logoOptional 
public java.lang.String getLogo();
  • Type: java.lang.String

Path to local file.

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

primaryColorContrastHexOptional 
public java.lang.String getPrimaryColorContrastHex();
  • Type: java.lang.String

Primary color contrast hex code.

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

primaryColorHexOptional 
public java.lang.String getPrimaryColorHex();
  • Type: java.lang.String

Primary color hex code.

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

secondaryColorContrastHexOptional 
public java.lang.String getSecondaryColorContrastHex();
  • Type: java.lang.String

Secondary color contrast hex code.

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

secondaryColorHexOptional 
public java.lang.String getSecondaryColorHex();
  • Type: java.lang.String

Secondary color hex code.

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

signInPageTouchPointVariantOptional 
public java.lang.String getSignInPageTouchPointVariant();
  • Type: java.lang.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.13.1/docs/resources/theme#sign_in_page_touch_point_variant Theme#sign_in_page_touch_point_variant}

themeIdOptional 
public java.lang.String getThemeId();
  • Type: java.lang.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.13.1/docs/resources/theme#theme_id Theme#theme_id}