emailcustomization

README

okta_email_customization

Refer to the Terraform Registory for docs: okta_email_customization.

Documentation

Index

• func EmailCustomization_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func EmailCustomization_IsConstruct(x interface{}) *bool
• func EmailCustomization_IsTerraformElement(x interface{}) *bool
• func EmailCustomization_IsTerraformResource(x interface{}) *bool
• func EmailCustomization_TfResourceType() *string
• func NewEmailCustomization_Override(e EmailCustomization, scope constructs.Construct, id *string, ...)
• type EmailCustomization
  • func NewEmailCustomization(scope constructs.Construct, id *string, config *EmailCustomizationConfig) EmailCustomization
• type EmailCustomizationConfig

Functions

func EmailCustomization_GenerateConfigForImport

func EmailCustomization_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a EmailCustomization resource upon running "cdktf plan <stack-name>".

func EmailCustomization_IsConstruct

func EmailCustomization_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func EmailCustomization_IsTerraformElement

func EmailCustomization_IsTerraformElement(x interface{}) *bool

Experimental.

func EmailCustomization_IsTerraformResource

func EmailCustomization_IsTerraformResource(x interface{}) *bool

Experimental.

func EmailCustomization_TfResourceType

func EmailCustomization_TfResourceType() *string

func NewEmailCustomization_Override

func NewEmailCustomization_Override(e EmailCustomization, scope constructs.Construct, id *string, config *EmailCustomizationConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization okta_email_customization} Resource.

Types

type EmailCustomization

type EmailCustomization interface {
	cdktf.TerraformResource
	Body() *string
	SetBody(val *string)
	BodyInput() *string
	BrandId() *string
	SetBrandId(val *string)
	BrandIdInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	ForceIsDefault() *string
	SetForceIsDefault(val *string)
	ForceIsDefaultInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	IsDefault() interface{}
	SetIsDefault(val interface{})
	IsDefaultInput() interface{}
	Language() *string
	SetLanguage(val *string)
	LanguageInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Links() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Subject() *string
	SetSubject(val *string)
	SubjectInput() *string
	TemplateName() *string
	SetTemplateName(val *string)
	TemplateNameInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetBody()
	ResetForceIsDefault()
	ResetIsDefault()
	ResetLanguage()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSubject()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewEmailCustomization

func NewEmailCustomization(scope constructs.Construct, id *string, config *EmailCustomizationConfig) EmailCustomization

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization okta_email_customization} Resource.

type EmailCustomizationConfig

type EmailCustomizationConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Brand ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#brand_id EmailCustomization#brand_id}
	BrandId *string `field:"required" json:"brandId" yaml:"brandId"`
	// Template Name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#template_name EmailCustomization#template_name}
	TemplateName *string `field:"required" json:"templateName" yaml:"templateName"`
	// The body of the customization.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#body EmailCustomization#body}
	Body *string `field:"optional" json:"body" yaml:"body"`
	// 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.6.2/docs/resources/email_customization#force_is_default EmailCustomization#force_is_default}
	ForceIsDefault *string `field:"optional" json:"forceIsDefault" yaml:"forceIsDefault"`
	// Whether the customization is the default.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#is_default EmailCustomization#is_default}
	IsDefault interface{} `field:"optional" json:"isDefault" yaml:"isDefault"`
	// The language supported by the customization.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#language EmailCustomization#language}
	Language *string `field:"optional" json:"language" yaml:"language"`
	// The subject of the customization.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/email_customization#subject EmailCustomization#subject}
	Subject *string `field:"optional" json:"subject" yaml:"subject"`
}