Okta

v3.16.0 published on Wednesday, Sep 28, 2022 by Pulumi

EmailCustomization

Use this resource to create an email customization of an email template belonging to a brand in an Okta organization.

Create EmailCustomization Resource

new EmailCustomization(name: string, args: EmailCustomizationArgs, opts?: CustomResourceOptions);
@overload
def EmailCustomization(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       body: Optional[str] = None,
                       brand_id: Optional[str] = None,
                       is_default: Optional[bool] = None,
                       language: Optional[str] = None,
                       subject: Optional[str] = None,
                       template_name: Optional[str] = None)
@overload
def EmailCustomization(resource_name: str,
                       args: EmailCustomizationArgs,
                       opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args EmailCustomizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EmailCustomizationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EmailCustomizationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EmailCustomizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EmailCustomizationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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:

BrandId string

Brand ID

TemplateName string

Template Name

Body string

The body of the customization

IsDefault bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

Language string

The language supported by the customization

Subject string

The subject of the customization

BrandId string

Brand ID

TemplateName string

Template Name

Body string

The body of the customization

IsDefault bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

Language string

The language supported by the customization

Subject string

The subject of the customization

brandId String

Brand ID

templateName String

Template Name

body String

The body of the customization

isDefault Boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language String

The language supported by the customization

subject String

The subject of the customization

brandId string

Brand ID

templateName string

Template Name

body string

The body of the customization

isDefault boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language string

The language supported by the customization

subject string

The subject of the customization

brand_id str

Brand ID

template_name str

Template Name

body str

The body of the customization

is_default bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language str

The language supported by the customization

subject str

The subject of the customization

brandId String

Brand ID

templateName String

Template Name

body String

The body of the customization

isDefault Boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language String

The language supported by the customization

subject String

The subject of the customization

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

Id string

The provider-assigned unique ID for this managed resource.

Links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

id String

The provider-assigned unique ID for this managed resource.

links String

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

id string

The provider-assigned unique ID for this managed resource.

links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

id str

The provider-assigned unique ID for this managed resource.

links str

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

id String

The provider-assigned unique ID for this managed resource.

links String

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

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,
        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
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Body string

The body of the customization

BrandId string

Brand ID

IsDefault bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

Language string

The language supported by the customization

Links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

Subject string

The subject of the customization

TemplateName string

Template Name

Body string

The body of the customization

BrandId string

Brand ID

IsDefault bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

Language string

The language supported by the customization

Links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

Subject string

The subject of the customization

TemplateName string

Template Name

body String

The body of the customization

brandId String

Brand ID

isDefault Boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language String

The language supported by the customization

links String

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

subject String

The subject of the customization

templateName String

Template Name

body string

The body of the customization

brandId string

Brand ID

isDefault boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language string

The language supported by the customization

links string

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

subject string

The subject of the customization

templateName string

Template Name

body str

The body of the customization

brand_id str

Brand ID

is_default bool

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language str

The language supported by the customization

links str

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

subject str

The subject of the customization

template_name str

Template Name

body String

The body of the customization

brandId String

Brand ID

isDefault Boolean

Whether the customization is the default. If is_default is true and there is already a default customization when this resource is created will cause an error. Only set to true for updating a resource.

language String

The language supported by the customization

links String

(Read-Only) Link relations for this object - JSON HAL - Discoverable resources related to the email template

subject String

The subject of the customization

templateName String

Template Name

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.