Skip to content

Latest commit

 

History

History
1403 lines (880 loc) · 50.6 KB

theme.go.md

File metadata and controls

1403 lines (880 loc) · 50.6 KB
Raw

theme Submodule

Constructs

Theme

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

Initializers 

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

theme.NewTheme(scope Construct, id *string, config ThemeConfig) Theme
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ThemeConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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".
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 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

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

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

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 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

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 
func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

MoveToId 
func MoveToId(id *string)

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".

ResetBackgroundImage 
func ResetBackgroundImage()
ResetEmailTemplateTouchPointVariant 
func ResetEmailTemplateTouchPointVariant()
ResetEndUserDashboardTouchPointVariant 
func ResetEndUserDashboardTouchPointVariant()
ResetErrorPageTouchPointVariant 
func ResetErrorPageTouchPointVariant()
ResetFavicon 
func ResetFavicon()
ResetLogo 
func ResetLogo()
ResetPrimaryColorContrastHex 
func ResetPrimaryColorContrastHex()
ResetPrimaryColorHex 
func ResetPrimaryColorHex()
ResetSecondaryColorContrastHex 
func ResetSecondaryColorContrastHex()
ResetSecondaryColorHex 
func ResetSecondaryColorHex()
ResetSignInPageTouchPointVariant 
func ResetSignInPageTouchPointVariant()
ResetThemeId 
func 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 "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

theme.Theme_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

theme.Theme_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

theme.Theme_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

theme.Theme_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

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

importFromIdRequired
  • 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

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
BackgroundImageUrlRequired 
func BackgroundImageUrl() *string
  • Type: *string
FaviconUrlRequired 
func FaviconUrl() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
LinksRequired 
func Links() *string
  • Type: *string
LogoUrlRequired 
func LogoUrl() *string
  • Type: *string
BackgroundImageInputOptional 
func BackgroundImageInput() *string
  • Type: *string
BrandIdInputOptional 
func BrandIdInput() *string
  • Type: *string
EmailTemplateTouchPointVariantInputOptional 
func EmailTemplateTouchPointVariantInput() *string
  • Type: *string
EndUserDashboardTouchPointVariantInputOptional 
func EndUserDashboardTouchPointVariantInput() *string
  • Type: *string
ErrorPageTouchPointVariantInputOptional 
func ErrorPageTouchPointVariantInput() *string
  • Type: *string
FaviconInputOptional 
func FaviconInput() *string
  • Type: *string
LogoInputOptional 
func LogoInput() *string
  • Type: *string
PrimaryColorContrastHexInputOptional 
func PrimaryColorContrastHexInput() *string
  • Type: *string
PrimaryColorHexInputOptional 
func PrimaryColorHexInput() *string
  • Type: *string
SecondaryColorContrastHexInputOptional 
func SecondaryColorContrastHexInput() *string
  • Type: *string
SecondaryColorHexInputOptional 
func SecondaryColorHexInput() *string
  • Type: *string
SignInPageTouchPointVariantInputOptional 
func SignInPageTouchPointVariantInput() *string
  • Type: *string
ThemeIdInputOptional 
func ThemeIdInput() *string
  • Type: *string
BackgroundImageRequired 
func BackgroundImage() *string
  • Type: *string
BrandIdRequired 
func BrandId() *string
  • Type: *string
EmailTemplateTouchPointVariantRequired 
func EmailTemplateTouchPointVariant() *string
  • Type: *string
EndUserDashboardTouchPointVariantRequired 
func EndUserDashboardTouchPointVariant() *string
  • Type: *string
ErrorPageTouchPointVariantRequired 
func ErrorPageTouchPointVariant() *string
  • Type: *string
FaviconRequired 
func Favicon() *string
  • Type: *string
LogoRequired 
func Logo() *string
  • Type: *string
PrimaryColorContrastHexRequired 
func PrimaryColorContrastHex() *string
  • Type: *string
PrimaryColorHexRequired 
func PrimaryColorHex() *string
  • Type: *string
SecondaryColorContrastHexRequired 
func SecondaryColorContrastHex() *string
  • Type: *string
SecondaryColorHexRequired 
func SecondaryColorHex() *string
  • Type: *string
SignInPageTouchPointVariantRequired 
func SignInPageTouchPointVariant() *string
  • Type: *string
ThemeIdRequired 
func ThemeId() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

ThemeConfig

Initializer 

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/theme"

&theme.ThemeConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	BrandId: *string,
	BackgroundImage: *string,
	EmailTemplateTouchPointVariant: *string,
	EndUserDashboardTouchPointVariant: *string,
	ErrorPageTouchPointVariant: *string,
	Favicon: *string,
	Logo: *string,
	PrimaryColorContrastHex: *string,
	PrimaryColorHex: *string,
	SecondaryColorContrastHex: *string,
	SecondaryColorHex: *string,
	SignInPageTouchPointVariant: *string,
	ThemeId: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
BrandIdRequired 
BrandId *string
  • 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}

BackgroundImageOptional 
BackgroundImage *string
  • 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}

EmailTemplateTouchPointVariantOptional 
EmailTemplateTouchPointVariant *string
  • 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}

EndUserDashboardTouchPointVariantOptional 
EndUserDashboardTouchPointVariant *string
  • 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}

ErrorPageTouchPointVariantOptional 
ErrorPageTouchPointVariant *string
  • 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}

FaviconOptional 
Favicon *string
  • 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}

LogoOptional 
Logo *string
  • 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}

PrimaryColorContrastHexOptional 
PrimaryColorContrastHex *string
  • 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}

PrimaryColorHexOptional 
PrimaryColorHex *string
  • 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}

SecondaryColorContrastHexOptional 
SecondaryColorContrastHex *string
  • 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}

SecondaryColorHexOptional 
SecondaryColorHex *string
  • 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}

SignInPageTouchPointVariantOptional 
SignInPageTouchPointVariant *string
  • 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}

ThemeIdOptional 
ThemeId *string
  • 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}