okta.EmailCustomization

Create an email customization of an email template belonging to a brand in an Okta organization. Use this resource to create an email customization of an email template belonging to a brand in an Okta organization. > Okta’s public API is strict regarding the behavior of the ‘is_default’ property in an email customization. Make use of ‘depends_on’ meta argument to ensure the provider navigates email customization language versions seamlessly. Have all secondary customizations depend on the primary customization that is marked default. See Example Usage. > Caveats for creating an email customization. If this is the first customization being created for the email template, and ‘is_default’ is not set for the customization in its resource configuration, the API will respond with the created customization marked as default. The API will 400 if the language parameter is not one of the supported languages or the body parameter does not contain a required variable reference. The API will error 409 if ‘is_default’ is true and a default customization exists. The API will 404 for an invalid ‘brand_id’ or ’template_name’. > Caveats for updating an email customization. If the ‘is_default’ parameter is true, the previous default email customization has its ‘is_default’ set to false (see previous note about mitigating this with ‘depends_on’ meta argument). The API will 409 if there’s already another email customization for the specified language or the ‘is_default’ parameter is false and the email customization being updated is the default. The API will 400 if the language parameter is not one of the supported locales or the body parameter does not contain a required variable reference. The API will 404 for an invalid ‘brand_id’ or ’template_name’.

Create EmailCustomization Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EmailCustomization(name: string, args: EmailCustomizationArgs, opts?: CustomResourceOptions);

@overload
def EmailCustomization(resource_name: str,
                       args: EmailCustomizationArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def EmailCustomization(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       brand_id: Optional[str] = None,
                       template_name: Optional[str] = None,
                       body: Optional[str] = None,
                       force_is_default: Optional[str] = None,
                       is_default: Optional[bool] = None,
                       language: Optional[str] = None,
                       subject: Optional[str] = None)

func NewEmailCustomization(ctx *Context, name string, args EmailCustomizationArgs, opts ...ResourceOption) (*EmailCustomization, error)

public EmailCustomization(string name, EmailCustomizationArgs args, CustomResourceOptions? opts = null)

public EmailCustomization(String name, EmailCustomizationArgs args)
public EmailCustomization(String name, EmailCustomizationArgs args, CustomResourceOptions options)

type: okta:EmailCustomization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var emailCustomizationResource = new Okta.EmailCustomization("emailCustomizationResource", new()
{
    BrandId = "string",
    TemplateName = "string",
    Body = "string",
    IsDefault = false,
    Language = "string",
    Subject = "string",
});

example, err := okta.NewEmailCustomization(ctx, "emailCustomizationResource", &okta.EmailCustomizationArgs{
	BrandId:      pulumi.String("string"),
	TemplateName: pulumi.String("string"),
	Body:         pulumi.String("string"),
	IsDefault:    pulumi.Bool(false),
	Language:     pulumi.String("string"),
	Subject:      pulumi.String("string"),
})

var emailCustomizationResource = new EmailCustomization("emailCustomizationResource", EmailCustomizationArgs.builder()
    .brandId("string")
    .templateName("string")
    .body("string")
    .isDefault(false)
    .language("string")
    .subject("string")
    .build());

email_customization_resource = okta.EmailCustomization("emailCustomizationResource",
    brand_id="string",
    template_name="string",
    body="string",
    is_default=False,
    language="string",
    subject="string")

const emailCustomizationResource = new okta.EmailCustomization("emailCustomizationResource", {
    brandId: "string",
    templateName: "string",
    body: "string",
    isDefault: false,
    language: "string",
    subject: "string",
});

type: okta:EmailCustomization
properties:
    body: string
    brandId: string
    isDefault: false
    language: string
    subject: string
    templateName: string

EmailCustomization Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EmailCustomization resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the EmailCustomization resource produces the following output properties:

Look up Existing EmailCustomization Resource

Get an existing EmailCustomization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EmailCustomizationState, opts?: CustomResourceOptions): EmailCustomization

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        brand_id: Optional[str] = None,
        force_is_default: Optional[str] = None,
        is_default: Optional[bool] = None,
        language: Optional[str] = None,
        links: Optional[str] = None,
        subject: Optional[str] = None,
        template_name: Optional[str] = None) -> EmailCustomization

func GetEmailCustomization(ctx *Context, name string, id IDInput, state *EmailCustomizationState, opts ...ResourceOption) (*EmailCustomization, error)

public static EmailCustomization Get(string name, Input<string> id, EmailCustomizationState? state, CustomResourceOptions? opts = null)

public static EmailCustomization get(String name, Output<String> id, EmailCustomizationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

Import

$ pulumi import okta:index/emailCustomization:EmailCustomization example <customization_id>/<brand_id>/<template_name>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

Okta pulumi/pulumi-okta

License

Apache-2.0

Notes

This Pulumi package is based on the okta Terraform Provider.