Skip to content

Latest commit

 

History

History
1279 lines (812 loc) · 54.5 KB

emailCustomization.python.md

File metadata and controls

1279 lines (812 loc) · 54.5 KB
Raw

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 

from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomization(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  brand_id: str,
  template_name: str,
  body: str = None,
  force_is_default: str = None,
  is_default: typing.Union[bool, IResolvable] = None,
  language: str = None,
  subject: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
brand_id str Brand ID.
template_name str 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 str The body of the customization.
force_is_default str Force is_default on the create and delete by deleting all email customizations.
is_default typing.Union[bool, cdktf.IResolvable] Whether the customization is the default.
language str The language supported by the customization - Example values from supported languages.
subject str The subject of the customization.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
brand_idRequired
  • Type: str

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}

template_nameRequired
  • Type: str

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}

bodyOptional
  • Type: str

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}

force_is_defaultOptional
  • Type: str

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}

is_defaultOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

languageOptional
  • Type: str

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}

subjectOptional
  • Type: str

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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_body No description.
reset_force_is_default No description.
reset_is_default No description.
reset_language No description.
reset_subject No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_body 
def reset_body() -> None
reset_force_is_default 
def reset_force_is_default() -> None
reset_is_default 
def reset_is_default() -> None
reset_language 
def reset_language() -> None
reset_subject 
def reset_subject() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a EmailCustomization resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomization.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomization.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomization.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomization.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
id str No description.
links str No description.
body_input str No description.
brand_id_input str No description.
force_is_default_input str No description.
is_default_input typing.Union[bool, cdktf.IResolvable] No description.
language_input str No description.
subject_input str No description.
template_name_input str No description.
body str No description.
brand_id str No description.
force_is_default str No description.
is_default typing.Union[bool, cdktf.IResolvable] No description.
language str No description.
subject str No description.
template_name str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
idRequired 
id: str
  • Type: str
linksRequired 
links: str
  • Type: str
body_inputOptional 
body_input: str
  • Type: str
brand_id_inputOptional 
brand_id_input: str
  • Type: str
force_is_default_inputOptional 
force_is_default_input: str
  • Type: str
is_default_inputOptional 
is_default_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
language_inputOptional 
language_input: str
  • Type: str
subject_inputOptional 
subject_input: str
  • Type: str
template_name_inputOptional 
template_name_input: str
  • Type: str
bodyRequired 
body: str
  • Type: str
brand_idRequired 
brand_id: str
  • Type: str
force_is_defaultRequired 
force_is_default: str
  • Type: str
is_defaultRequired 
is_default: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
languageRequired 
language: str
  • Type: str
subjectRequired 
subject: str
  • Type: str
template_nameRequired 
template_name: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

EmailCustomizationConfig

Initializer 

from cdktf_cdktf_provider_okta import email_customization

emailCustomization.EmailCustomizationConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  brand_id: str,
  template_name: str,
  body: str = None,
  force_is_default: str = None,
  is_default: typing.Union[bool, IResolvable] = None,
  language: str = None,
  subject: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
brand_id str Brand ID.
template_name str 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 str The body of the customization.
force_is_default str Force is_default on the create and delete by deleting all email customizations.
is_default typing.Union[bool, cdktf.IResolvable] Whether the customization is the default.
language str The language supported by the customization - Example values from supported languages.
subject str The subject of the customization.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
brand_idRequired 
brand_id: str
  • Type: str

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}

template_nameRequired 
template_name: str
  • Type: str

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}

bodyOptional 
body: str
  • Type: str

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}

force_is_defaultOptional 
force_is_default: str
  • Type: str

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}

is_defaultOptional 
is_default: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

languageOptional 
language: str
  • Type: str

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}

subjectOptional 
subject: str
  • Type: str

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}