emailCustomization.csharp.md

emailCustomization Submodule

Constructs

EmailCustomization

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

Initializers

using HashiCorp.Cdktf.Providers.Okta;

new EmailCustomization(Construct Scope, string Id, EmailCustomizationConfig Config);

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

---

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".
ResetBody	No description.
ResetForceIsDefault	No description.
ResetIsDefault	No description.
ResetLanguage	No description.
ResetSubject	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".

---

ResetBody

private void ResetBody()

ResetForceIsDefault

private void ResetForceIsDefault()

ResetIsDefault

private void ResetIsDefault()

ResetLanguage

private void ResetLanguage()

ResetSubject

private void ResetSubject()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Okta;

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

EmailCustomization.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Okta;

EmailCustomization.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Okta;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing EmailCustomization that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#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 EmailCustomization 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.
Id	string	No description.
Links	string	No description.
BodyInput	string	No description.
BrandIdInput	string	No description.
ForceIsDefaultInput	string	No description.
IsDefaultInput	object	No description.
LanguageInput	string	No description.
SubjectInput	string	No description.
TemplateNameInput	string	No description.
Body	string	No description.
BrandId	string	No description.
ForceIsDefault	string	No description.
IsDefault	object	No description.
Language	string	No description.
Subject	string	No description.
TemplateName	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[]

---

Id^Required

public string Id { get; }

• Type: string

---

Links^Required

public string Links { get; }

• Type: string

---

BodyInput^Optional

public string BodyInput { get; }

• Type: string

---

BrandIdInput^Optional

public string BrandIdInput { get; }

• Type: string

---

ForceIsDefaultInput^Optional

public string ForceIsDefaultInput { get; }

• Type: string

---

IsDefaultInput^Optional

public object IsDefaultInput { get; }

• Type: object

---

LanguageInput^Optional

public string LanguageInput { get; }

• Type: string

---

SubjectInput^Optional

public string SubjectInput { get; }

• Type: string

---

TemplateNameInput^Optional

public string TemplateNameInput { get; }

• Type: string

---

Body^Required

public string Body { get; }

• Type: string

---

BrandId^Required

public string BrandId { get; }

• Type: string

---

ForceIsDefault^Required

public string ForceIsDefault { get; }

• Type: string

---

IsDefault^Required

public object IsDefault { get; }

• Type: object

---

Language^Required

public string Language { get; }

• Type: string

---

Subject^Required

public string Subject { get; }

• Type: string

---

TemplateName^Required

public string TemplateName { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

EmailCustomizationConfig

Initializer

using HashiCorp.Cdktf.Providers.Okta;

new EmailCustomizationConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BrandId,
    string TemplateName,
    string Body = null,
    string ForceIsDefault = null,
    object IsDefault = null,
    string Language = null,
    string Subject = 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.
TemplateName	string	Template Name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation.
Body	string	The body of the customization.
ForceIsDefault	string	Force is_default on the create and delete by deleting all email customizations.
IsDefault	object	Whether the customization is the default.
Language	string	The language supported by the customization - Example values from supported languages.
Subject	string	The subject of the customization.

---

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.8.1/docs/resources/email_customization#brand_id EmailCustomization#brand_id}

---

TemplateName^Required

public string TemplateName { get; set; }

• Type: string

Template Name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#template_name EmailCustomization#template_name}

---

Body^Optional

public string Body { get; set; }

• Type: string

The body of the customization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#body EmailCustomization#body}

---

ForceIsDefault^Optional

public string ForceIsDefault { get; set; }

• Type: string

Force is_default on the create and delete by deleting all email customizations.

Comma separated string with values of 'create' or 'destroy' or both `create,destroy'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#force_is_default EmailCustomization#force_is_default}

---

IsDefault^Optional

public object IsDefault { get; set; }

• Type: object

Whether the customization is the default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#is_default EmailCustomization#is_default}

---

Language^Optional

public string Language { get; set; }

• Type: string

The language supported by the customization - Example values from supported languages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#language EmailCustomization#language}

---

Subject^Optional

public string Subject { get; set; }

• Type: string

The subject of the customization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/email_customization#subject EmailCustomization#subject}

---