template

package
v2.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Email 

type Email struct {
	pulumi.CustomResourceState

	// The default language, by default is set to `"en"`.
	DefaultLanguage pulumi.StringPtrOutput `pulumi:"defaultLanguage"`
	// Set of translations for a particular template.
	Translations EmailTranslationArrayOutput `pulumi:"translations"`
	// Email template type
	Type pulumi.StringOutput `pulumi:"type"`
}

Creates an Okta Email Template.

This resource allows you to create and configure an Okta Email Template.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-okta/sdk/v2/go/okta/template"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := template.NewEmail(ctx, "example", &template.EmailArgs{
			Translations: template.EmailTranslationArray{
				&template.EmailTranslationArgs{
					Language: pulumi.String("en"),
					Subject:  pulumi.String("Stuff"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Hi ", user.FirstName, ",<br/><br/>Blah blah ", resetPasswordLink)),
				},
				&template.EmailTranslationArgs{
					Language: pulumi.String("es"),
					Subject:  pulumi.String("Cosas"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Hola ", user.FirstName, ",<br/><br/>Puedo ir al bano ", resetPasswordLink)),
				},
			},
			Type: pulumi.String("email.forgotPassword"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An Okta Email Template can be imported via the template type.

```sh 

$ pulumi import okta:template/email:Email example <template type>

```

func GetEmail 

func GetEmail(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EmailState, opts ...pulumi.ResourceOption) (*Email, error)

GetEmail gets an existing Email resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEmail 

func NewEmail(ctx *pulumi.Context,
	name string, args *EmailArgs, opts ...pulumi.ResourceOption) (*Email, error)

NewEmail registers a new resource with the given unique name, arguments, and options.

func (*Email) ElementType added in v2.6.2 

func (*Email) ElementType() reflect.Type

func (*Email) ToEmailOutput added in v2.6.2 

func (i *Email) ToEmailOutput() EmailOutput

func (*Email) ToEmailOutputWithContext added in v2.6.2 

func (i *Email) ToEmailOutputWithContext(ctx context.Context) EmailOutput

func (*Email) ToEmailPtrOutput added in v2.10.1 

func (i *Email) ToEmailPtrOutput() EmailPtrOutput

func (*Email) ToEmailPtrOutputWithContext added in v2.10.1 

func (i *Email) ToEmailPtrOutputWithContext(ctx context.Context) EmailPtrOutput

type EmailArgs 

type EmailArgs struct {
	// The default language, by default is set to `"en"`.
	DefaultLanguage pulumi.StringPtrInput
	// Set of translations for a particular template.
	Translations EmailTranslationArrayInput
	// Email template type
	Type pulumi.StringInput
}

The set of arguments for constructing a Email resource.

func (EmailArgs) ElementType 

func (EmailArgs) ElementType() reflect.Type

type EmailArray added in v2.10.1 

type EmailArray []EmailInput

func (EmailArray) ElementType added in v2.10.1 

func (EmailArray) ElementType() reflect.Type

func (EmailArray) ToEmailArrayOutput added in v2.10.1 

func (i EmailArray) ToEmailArrayOutput() EmailArrayOutput

func (EmailArray) ToEmailArrayOutputWithContext added in v2.10.1 

func (i EmailArray) ToEmailArrayOutputWithContext(ctx context.Context) EmailArrayOutput

type EmailArrayInput added in v2.10.1 

type EmailArrayInput interface {
	pulumi.Input

	ToEmailArrayOutput() EmailArrayOutput
	ToEmailArrayOutputWithContext(context.Context) EmailArrayOutput
}

EmailArrayInput is an input type that accepts EmailArray and EmailArrayOutput values. You can construct a concrete instance of `EmailArrayInput` via: 

EmailArray{ EmailArgs{...} }

type EmailArrayOutput added in v2.10.1 

type EmailArrayOutput struct{ *pulumi.OutputState }

func (EmailArrayOutput) ElementType added in v2.10.1 

func (EmailArrayOutput) ElementType() reflect.Type

func (EmailArrayOutput) Index added in v2.10.1 

func (o EmailArrayOutput) Index(i pulumi.IntInput) EmailOutput

func (EmailArrayOutput) ToEmailArrayOutput added in v2.10.1 

func (o EmailArrayOutput) ToEmailArrayOutput() EmailArrayOutput

func (EmailArrayOutput) ToEmailArrayOutputWithContext added in v2.10.1 

func (o EmailArrayOutput) ToEmailArrayOutputWithContext(ctx context.Context) EmailArrayOutput

type EmailInput added in v2.6.2 

type EmailInput interface {
	pulumi.Input

	ToEmailOutput() EmailOutput
	ToEmailOutputWithContext(ctx context.Context) EmailOutput
}

type EmailMap added in v2.10.1 

type EmailMap map[string]EmailInput

func (EmailMap) ElementType added in v2.10.1 

func (EmailMap) ElementType() reflect.Type

func (EmailMap) ToEmailMapOutput added in v2.10.1 

func (i EmailMap) ToEmailMapOutput() EmailMapOutput

func (EmailMap) ToEmailMapOutputWithContext added in v2.10.1 

func (i EmailMap) ToEmailMapOutputWithContext(ctx context.Context) EmailMapOutput

type EmailMapInput added in v2.10.1 

type EmailMapInput interface {
	pulumi.Input

	ToEmailMapOutput() EmailMapOutput
	ToEmailMapOutputWithContext(context.Context) EmailMapOutput
}

EmailMapInput is an input type that accepts EmailMap and EmailMapOutput values. You can construct a concrete instance of `EmailMapInput` via: 

EmailMap{ "key": EmailArgs{...} }

type EmailMapOutput added in v2.10.1 

type EmailMapOutput struct{ *pulumi.OutputState }

func (EmailMapOutput) ElementType added in v2.10.1 

func (EmailMapOutput) ElementType() reflect.Type

func (EmailMapOutput) MapIndex added in v2.10.1 

func (o EmailMapOutput) MapIndex(k pulumi.StringInput) EmailOutput

func (EmailMapOutput) ToEmailMapOutput added in v2.10.1 

func (o EmailMapOutput) ToEmailMapOutput() EmailMapOutput

func (EmailMapOutput) ToEmailMapOutputWithContext added in v2.10.1 

func (o EmailMapOutput) ToEmailMapOutputWithContext(ctx context.Context) EmailMapOutput

type EmailOutput added in v2.6.2 

type EmailOutput struct {
	*pulumi.OutputState
}

func (EmailOutput) ElementType added in v2.6.2 

func (EmailOutput) ElementType() reflect.Type

func (EmailOutput) ToEmailOutput added in v2.6.2 

func (o EmailOutput) ToEmailOutput() EmailOutput

func (EmailOutput) ToEmailOutputWithContext added in v2.6.2 

func (o EmailOutput) ToEmailOutputWithContext(ctx context.Context) EmailOutput

func (EmailOutput) ToEmailPtrOutput added in v2.10.1 

func (o EmailOutput) ToEmailPtrOutput() EmailPtrOutput

func (EmailOutput) ToEmailPtrOutputWithContext added in v2.10.1 

func (o EmailOutput) ToEmailPtrOutputWithContext(ctx context.Context) EmailPtrOutput

type EmailPtrInput added in v2.10.1 

type EmailPtrInput interface {
	pulumi.Input

	ToEmailPtrOutput() EmailPtrOutput
	ToEmailPtrOutputWithContext(ctx context.Context) EmailPtrOutput
}

type EmailPtrOutput added in v2.10.1 

type EmailPtrOutput struct {
	*pulumi.OutputState
}

func (EmailPtrOutput) ElementType added in v2.10.1 

func (EmailPtrOutput) ElementType() reflect.Type

func (EmailPtrOutput) ToEmailPtrOutput added in v2.10.1 

func (o EmailPtrOutput) ToEmailPtrOutput() EmailPtrOutput

func (EmailPtrOutput) ToEmailPtrOutputWithContext added in v2.10.1 

func (o EmailPtrOutput) ToEmailPtrOutputWithContext(ctx context.Context) EmailPtrOutput

type EmailState 

type EmailState struct {
	// The default language, by default is set to `"en"`.
	DefaultLanguage pulumi.StringPtrInput
	// Set of translations for a particular template.
	Translations EmailTranslationArrayInput
	// Email template type
	Type pulumi.StringPtrInput
}

func (EmailState) ElementType 

func (EmailState) ElementType() reflect.Type

type EmailTranslation 

type EmailTranslation struct {
	// The language to map the template to.
	Language string `pulumi:"language"`
	// The email subject line.
	Subject string `pulumi:"subject"`
	// The email body.
	Template string `pulumi:"template"`
}

type EmailTranslationArgs 

type EmailTranslationArgs struct {
	// The language to map the template to.
	Language pulumi.StringInput `pulumi:"language"`
	// The email subject line.
	Subject pulumi.StringInput `pulumi:"subject"`
	// The email body.
	Template pulumi.StringInput `pulumi:"template"`
}

func (EmailTranslationArgs) ElementType 

func (EmailTranslationArgs) ElementType() reflect.Type

func (EmailTranslationArgs) ToEmailTranslationOutput 

func (i EmailTranslationArgs) ToEmailTranslationOutput() EmailTranslationOutput

func (EmailTranslationArgs) ToEmailTranslationOutputWithContext 

func (i EmailTranslationArgs) ToEmailTranslationOutputWithContext(ctx context.Context) EmailTranslationOutput

type EmailTranslationArray 

type EmailTranslationArray []EmailTranslationInput

func (EmailTranslationArray) ElementType 

func (EmailTranslationArray) ElementType() reflect.Type

func (EmailTranslationArray) ToEmailTranslationArrayOutput 

func (i EmailTranslationArray) ToEmailTranslationArrayOutput() EmailTranslationArrayOutput

func (EmailTranslationArray) ToEmailTranslationArrayOutputWithContext 

func (i EmailTranslationArray) ToEmailTranslationArrayOutputWithContext(ctx context.Context) EmailTranslationArrayOutput

type EmailTranslationArrayInput 

type EmailTranslationArrayInput interface {
	pulumi.Input

	ToEmailTranslationArrayOutput() EmailTranslationArrayOutput
	ToEmailTranslationArrayOutputWithContext(context.Context) EmailTranslationArrayOutput
}

EmailTranslationArrayInput is an input type that accepts EmailTranslationArray and EmailTranslationArrayOutput values. You can construct a concrete instance of `EmailTranslationArrayInput` via: 

EmailTranslationArray{ EmailTranslationArgs{...} }

type EmailTranslationArrayOutput 

type EmailTranslationArrayOutput struct{ *pulumi.OutputState }

func (EmailTranslationArrayOutput) ElementType 

func (EmailTranslationArrayOutput) ElementType() reflect.Type

func (EmailTranslationArrayOutput) Index 

func (o EmailTranslationArrayOutput) Index(i pulumi.IntInput) EmailTranslationOutput

func (EmailTranslationArrayOutput) ToEmailTranslationArrayOutput 

func (o EmailTranslationArrayOutput) ToEmailTranslationArrayOutput() EmailTranslationArrayOutput

func (EmailTranslationArrayOutput) ToEmailTranslationArrayOutputWithContext 

func (o EmailTranslationArrayOutput) ToEmailTranslationArrayOutputWithContext(ctx context.Context) EmailTranslationArrayOutput

type EmailTranslationInput 

type EmailTranslationInput interface {
	pulumi.Input

	ToEmailTranslationOutput() EmailTranslationOutput
	ToEmailTranslationOutputWithContext(context.Context) EmailTranslationOutput
}

EmailTranslationInput is an input type that accepts EmailTranslationArgs and EmailTranslationOutput values. You can construct a concrete instance of `EmailTranslationInput` via: 

EmailTranslationArgs{...}

type EmailTranslationOutput 

type EmailTranslationOutput struct{ *pulumi.OutputState }

func (EmailTranslationOutput) ElementType 

func (EmailTranslationOutput) ElementType() reflect.Type

func (EmailTranslationOutput) Language 

func (o EmailTranslationOutput) Language() pulumi.StringOutput

The language to map the template to.

func (EmailTranslationOutput) Subject 

func (o EmailTranslationOutput) Subject() pulumi.StringOutput

The email subject line.

func (EmailTranslationOutput) Template 

func (o EmailTranslationOutput) Template() pulumi.StringOutput

The email body.

func (EmailTranslationOutput) ToEmailTranslationOutput 

func (o EmailTranslationOutput) ToEmailTranslationOutput() EmailTranslationOutput

func (EmailTranslationOutput) ToEmailTranslationOutputWithContext 

func (o EmailTranslationOutput) ToEmailTranslationOutputWithContext(ctx context.Context) EmailTranslationOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.