okta

package
v2.4.2 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing okta resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EventHook added in v2.4.0 

type EventHook struct {
	pulumi.CustomResourceState

	// Authentication required for event hook request.
	Auth EventHookAuthPtrOutput `pulumi:"auth"`
	// Details of the endpoint the event hook will hit.
	Channel EventHookChannelOutput `pulumi:"channel"`
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayOutput `pulumi:"events"`
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayOutput `pulumi:"headers"`
	// The event hook display name.
	Name   pulumi.StringOutput    `pulumi:"name"`
	Status pulumi.StringPtrOutput `pulumi:"status"`
}

Creates an event hook.

This resource allows you to create and configure an event hook.

## Example Usage

```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewEventHook(ctx, "example", &okta.EventHookArgs{
			Auth: &okta.EventHookAuthArgs{
				Key:   pulumi.String("Authorization"),
				Type:  pulumi.String("HEADER"),
				Value: pulumi.String("123"),
			},
			Channel: &okta.EventHookChannelArgs{
				Type:    pulumi.String("HTTP"),
				Uri:     pulumi.String("https://example.com/test"),
				Version: pulumi.String("1.0.0"),
			},
			Events: pulumi.StringArray{
				pulumi.String("user.lifecycle.create"),
				pulumi.String("user.lifecycle.delete.initiated"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetEventHook added in v2.4.0 

func GetEventHook(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EventHookState, opts ...pulumi.ResourceOption) (*EventHook, error)

GetEventHook gets an existing EventHook 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 NewEventHook added in v2.4.0 

func NewEventHook(ctx *pulumi.Context,
	name string, args *EventHookArgs, opts ...pulumi.ResourceOption) (*EventHook, error)

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

type EventHookArgs added in v2.4.0 

type EventHookArgs struct {
	// Authentication required for event hook request.
	Auth EventHookAuthPtrInput
	// Details of the endpoint the event hook will hit.
	Channel EventHookChannelInput
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayInput
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayInput
	// The event hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
}

The set of arguments for constructing a EventHook resource.

func (EventHookArgs) ElementType added in v2.4.0 

func (EventHookArgs) ElementType() reflect.Type

type EventHookAuth added in v2.4.0 

type EventHookAuth struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key string `pulumi:"key"`
	// The type of hook to trigger. Currently only `"HTTP"` is supported.
	Type string `pulumi:"type"`
	// Authentication secret.
	Value string `pulumi:"value"`
}

type EventHookAuthArgs added in v2.4.0 

type EventHookAuthArgs struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key pulumi.StringInput `pulumi:"key"`
	// The type of hook to trigger. Currently only `"HTTP"` is supported.
	Type pulumi.StringInput `pulumi:"type"`
	// Authentication secret.
	Value pulumi.StringInput `pulumi:"value"`
}

func (EventHookAuthArgs) ElementType added in v2.4.0 

func (EventHookAuthArgs) ElementType() reflect.Type

func (EventHookAuthArgs) ToEventHookAuthOutput added in v2.4.0 

func (i EventHookAuthArgs) ToEventHookAuthOutput() EventHookAuthOutput

func (EventHookAuthArgs) ToEventHookAuthOutputWithContext added in v2.4.0 

func (i EventHookAuthArgs) ToEventHookAuthOutputWithContext(ctx context.Context) EventHookAuthOutput

func (EventHookAuthArgs) ToEventHookAuthPtrOutput added in v2.4.0 

func (i EventHookAuthArgs) ToEventHookAuthPtrOutput() EventHookAuthPtrOutput

func (EventHookAuthArgs) ToEventHookAuthPtrOutputWithContext added in v2.4.0 

func (i EventHookAuthArgs) ToEventHookAuthPtrOutputWithContext(ctx context.Context) EventHookAuthPtrOutput

type EventHookAuthInput added in v2.4.0 

type EventHookAuthInput interface {
	pulumi.Input

	ToEventHookAuthOutput() EventHookAuthOutput
	ToEventHookAuthOutputWithContext(context.Context) EventHookAuthOutput
}

EventHookAuthInput is an input type that accepts EventHookAuthArgs and EventHookAuthOutput values. You can construct a concrete instance of `EventHookAuthInput` via: 

EventHookAuthArgs{...}

type EventHookAuthOutput added in v2.4.0 

type EventHookAuthOutput struct{ *pulumi.OutputState }

func (EventHookAuthOutput) ElementType added in v2.4.0 

func (EventHookAuthOutput) ElementType() reflect.Type

func (EventHookAuthOutput) Key added in v2.4.0 

func (o EventHookAuthOutput) Key() pulumi.StringOutput

Key to use for authentication, usually the header name, for example `"Authorization"`.

func (EventHookAuthOutput) ToEventHookAuthOutput added in v2.4.0 

func (o EventHookAuthOutput) ToEventHookAuthOutput() EventHookAuthOutput

func (EventHookAuthOutput) ToEventHookAuthOutputWithContext added in v2.4.0 

func (o EventHookAuthOutput) ToEventHookAuthOutputWithContext(ctx context.Context) EventHookAuthOutput

func (EventHookAuthOutput) ToEventHookAuthPtrOutput added in v2.4.0 

func (o EventHookAuthOutput) ToEventHookAuthPtrOutput() EventHookAuthPtrOutput

func (EventHookAuthOutput) ToEventHookAuthPtrOutputWithContext added in v2.4.0 

func (o EventHookAuthOutput) ToEventHookAuthPtrOutputWithContext(ctx context.Context) EventHookAuthPtrOutput

func (EventHookAuthOutput) Type added in v2.4.0 

func (o EventHookAuthOutput) Type() pulumi.StringOutput

The type of hook to trigger. Currently only `"HTTP"` is supported.

func (EventHookAuthOutput) Value added in v2.4.0 

func (o EventHookAuthOutput) Value() pulumi.StringOutput

Authentication secret.

type EventHookAuthPtrInput added in v2.4.0 

type EventHookAuthPtrInput interface {
	pulumi.Input

	ToEventHookAuthPtrOutput() EventHookAuthPtrOutput
	ToEventHookAuthPtrOutputWithContext(context.Context) EventHookAuthPtrOutput
}

EventHookAuthPtrInput is an input type that accepts EventHookAuthArgs, EventHookAuthPtr and EventHookAuthPtrOutput values. You can construct a concrete instance of `EventHookAuthPtrInput` via: 

        EventHookAuthArgs{...}

or:

        nil

func EventHookAuthPtr added in v2.4.0 

func EventHookAuthPtr(v *EventHookAuthArgs) EventHookAuthPtrInput

type EventHookAuthPtrOutput added in v2.4.0 

type EventHookAuthPtrOutput struct{ *pulumi.OutputState }

func (EventHookAuthPtrOutput) Elem added in v2.4.0 

func (o EventHookAuthPtrOutput) Elem() EventHookAuthOutput

func (EventHookAuthPtrOutput) ElementType added in v2.4.0 

func (EventHookAuthPtrOutput) ElementType() reflect.Type

func (EventHookAuthPtrOutput) Key added in v2.4.0 

func (o EventHookAuthPtrOutput) Key() pulumi.StringPtrOutput

Key to use for authentication, usually the header name, for example `"Authorization"`.

func (EventHookAuthPtrOutput) ToEventHookAuthPtrOutput added in v2.4.0 

func (o EventHookAuthPtrOutput) ToEventHookAuthPtrOutput() EventHookAuthPtrOutput

func (EventHookAuthPtrOutput) ToEventHookAuthPtrOutputWithContext added in v2.4.0 

func (o EventHookAuthPtrOutput) ToEventHookAuthPtrOutputWithContext(ctx context.Context) EventHookAuthPtrOutput

func (EventHookAuthPtrOutput) Type added in v2.4.0 

func (o EventHookAuthPtrOutput) Type() pulumi.StringPtrOutput

The type of hook to trigger. Currently only `"HTTP"` is supported.

func (EventHookAuthPtrOutput) Value added in v2.4.0 

func (o EventHookAuthPtrOutput) Value() pulumi.StringPtrOutput

Authentication secret.

type EventHookChannel added in v2.4.0 

type EventHookChannel struct {
	// The type of hook to trigger. Currently only `"HTTP"` is supported.
	Type string `pulumi:"type"`
	// The URI the hook will hit.
	Uri string `pulumi:"uri"`
	// The version of the channel. Currently only `"1.0.0"` is supported.
	Version string `pulumi:"version"`
}

type EventHookChannelArgs added in v2.4.0 

type EventHookChannelArgs struct {
	// The type of hook to trigger. Currently only `"HTTP"` is supported.
	Type pulumi.StringInput `pulumi:"type"`
	// The URI the hook will hit.
	Uri pulumi.StringInput `pulumi:"uri"`
	// The version of the channel. Currently only `"1.0.0"` is supported.
	Version pulumi.StringInput `pulumi:"version"`
}

func (EventHookChannelArgs) ElementType added in v2.4.0 

func (EventHookChannelArgs) ElementType() reflect.Type

func (EventHookChannelArgs) ToEventHookChannelOutput added in v2.4.0 

func (i EventHookChannelArgs) ToEventHookChannelOutput() EventHookChannelOutput

func (EventHookChannelArgs) ToEventHookChannelOutputWithContext added in v2.4.0 

func (i EventHookChannelArgs) ToEventHookChannelOutputWithContext(ctx context.Context) EventHookChannelOutput

func (EventHookChannelArgs) ToEventHookChannelPtrOutput added in v2.4.0 

func (i EventHookChannelArgs) ToEventHookChannelPtrOutput() EventHookChannelPtrOutput

func (EventHookChannelArgs) ToEventHookChannelPtrOutputWithContext added in v2.4.0 

func (i EventHookChannelArgs) ToEventHookChannelPtrOutputWithContext(ctx context.Context) EventHookChannelPtrOutput

type EventHookChannelInput added in v2.4.0 

type EventHookChannelInput interface {
	pulumi.Input

	ToEventHookChannelOutput() EventHookChannelOutput
	ToEventHookChannelOutputWithContext(context.Context) EventHookChannelOutput
}

EventHookChannelInput is an input type that accepts EventHookChannelArgs and EventHookChannelOutput values. You can construct a concrete instance of `EventHookChannelInput` via: 

EventHookChannelArgs{...}

type EventHookChannelOutput added in v2.4.0 

type EventHookChannelOutput struct{ *pulumi.OutputState }

func (EventHookChannelOutput) ElementType added in v2.4.0 

func (EventHookChannelOutput) ElementType() reflect.Type

func (EventHookChannelOutput) ToEventHookChannelOutput added in v2.4.0 

func (o EventHookChannelOutput) ToEventHookChannelOutput() EventHookChannelOutput

func (EventHookChannelOutput) ToEventHookChannelOutputWithContext added in v2.4.0 

func (o EventHookChannelOutput) ToEventHookChannelOutputWithContext(ctx context.Context) EventHookChannelOutput

func (EventHookChannelOutput) ToEventHookChannelPtrOutput added in v2.4.0 

func (o EventHookChannelOutput) ToEventHookChannelPtrOutput() EventHookChannelPtrOutput

func (EventHookChannelOutput) ToEventHookChannelPtrOutputWithContext added in v2.4.0 

func (o EventHookChannelOutput) ToEventHookChannelPtrOutputWithContext(ctx context.Context) EventHookChannelPtrOutput

func (EventHookChannelOutput) Type added in v2.4.0 

func (o EventHookChannelOutput) Type() pulumi.StringOutput

The type of hook to trigger. Currently only `"HTTP"` is supported.

func (EventHookChannelOutput) Uri added in v2.4.0 

func (o EventHookChannelOutput) Uri() pulumi.StringOutput

The URI the hook will hit.

func (EventHookChannelOutput) Version added in v2.4.0 

func (o EventHookChannelOutput) Version() pulumi.StringOutput

The version of the channel. Currently only `"1.0.0"` is supported.

type EventHookChannelPtrInput added in v2.4.0 

type EventHookChannelPtrInput interface {
	pulumi.Input

	ToEventHookChannelPtrOutput() EventHookChannelPtrOutput
	ToEventHookChannelPtrOutputWithContext(context.Context) EventHookChannelPtrOutput
}

EventHookChannelPtrInput is an input type that accepts EventHookChannelArgs, EventHookChannelPtr and EventHookChannelPtrOutput values. You can construct a concrete instance of `EventHookChannelPtrInput` via: 

        EventHookChannelArgs{...}

or:

        nil

func EventHookChannelPtr added in v2.4.0 

func EventHookChannelPtr(v *EventHookChannelArgs) EventHookChannelPtrInput

type EventHookChannelPtrOutput added in v2.4.0 

type EventHookChannelPtrOutput struct{ *pulumi.OutputState }

func (EventHookChannelPtrOutput) Elem added in v2.4.0 

func (o EventHookChannelPtrOutput) Elem() EventHookChannelOutput

func (EventHookChannelPtrOutput) ElementType added in v2.4.0 

func (EventHookChannelPtrOutput) ElementType() reflect.Type

func (EventHookChannelPtrOutput) ToEventHookChannelPtrOutput added in v2.4.0 

func (o EventHookChannelPtrOutput) ToEventHookChannelPtrOutput() EventHookChannelPtrOutput

func (EventHookChannelPtrOutput) ToEventHookChannelPtrOutputWithContext added in v2.4.0 

func (o EventHookChannelPtrOutput) ToEventHookChannelPtrOutputWithContext(ctx context.Context) EventHookChannelPtrOutput

func (EventHookChannelPtrOutput) Type added in v2.4.0 

func (o EventHookChannelPtrOutput) Type() pulumi.StringPtrOutput

The type of hook to trigger. Currently only `"HTTP"` is supported.

func (EventHookChannelPtrOutput) Uri added in v2.4.0 

func (o EventHookChannelPtrOutput) Uri() pulumi.StringPtrOutput

The URI the hook will hit.

func (EventHookChannelPtrOutput) Version added in v2.4.0 

func (o EventHookChannelPtrOutput) Version() pulumi.StringPtrOutput

The version of the channel. Currently only `"1.0.0"` is supported.

type EventHookHeader added in v2.4.0 

type EventHookHeader struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key *string `pulumi:"key"`
	// Authentication secret.
	Value *string `pulumi:"value"`
}

type EventHookHeaderArgs added in v2.4.0 

type EventHookHeaderArgs struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// Authentication secret.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (EventHookHeaderArgs) ElementType added in v2.4.0 

func (EventHookHeaderArgs) ElementType() reflect.Type

func (EventHookHeaderArgs) ToEventHookHeaderOutput added in v2.4.0 

func (i EventHookHeaderArgs) ToEventHookHeaderOutput() EventHookHeaderOutput

func (EventHookHeaderArgs) ToEventHookHeaderOutputWithContext added in v2.4.0 

func (i EventHookHeaderArgs) ToEventHookHeaderOutputWithContext(ctx context.Context) EventHookHeaderOutput

type EventHookHeaderArray added in v2.4.0 

type EventHookHeaderArray []EventHookHeaderInput

func (EventHookHeaderArray) ElementType added in v2.4.0 

func (EventHookHeaderArray) ElementType() reflect.Type

func (EventHookHeaderArray) ToEventHookHeaderArrayOutput added in v2.4.0 

func (i EventHookHeaderArray) ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput

func (EventHookHeaderArray) ToEventHookHeaderArrayOutputWithContext added in v2.4.0 

func (i EventHookHeaderArray) ToEventHookHeaderArrayOutputWithContext(ctx context.Context) EventHookHeaderArrayOutput

type EventHookHeaderArrayInput added in v2.4.0 

type EventHookHeaderArrayInput interface {
	pulumi.Input

	ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput
	ToEventHookHeaderArrayOutputWithContext(context.Context) EventHookHeaderArrayOutput
}

EventHookHeaderArrayInput is an input type that accepts EventHookHeaderArray and EventHookHeaderArrayOutput values. You can construct a concrete instance of `EventHookHeaderArrayInput` via: 

EventHookHeaderArray{ EventHookHeaderArgs{...} }

type EventHookHeaderArrayOutput added in v2.4.0 

type EventHookHeaderArrayOutput struct{ *pulumi.OutputState }

func (EventHookHeaderArrayOutput) ElementType added in v2.4.0 

func (EventHookHeaderArrayOutput) ElementType() reflect.Type

func (EventHookHeaderArrayOutput) Index added in v2.4.0 

func (o EventHookHeaderArrayOutput) Index(i pulumi.IntInput) EventHookHeaderOutput

func (EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutput added in v2.4.0 

func (o EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutput() EventHookHeaderArrayOutput

func (EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutputWithContext added in v2.4.0 

func (o EventHookHeaderArrayOutput) ToEventHookHeaderArrayOutputWithContext(ctx context.Context) EventHookHeaderArrayOutput

type EventHookHeaderInput added in v2.4.0 

type EventHookHeaderInput interface {
	pulumi.Input

	ToEventHookHeaderOutput() EventHookHeaderOutput
	ToEventHookHeaderOutputWithContext(context.Context) EventHookHeaderOutput
}

EventHookHeaderInput is an input type that accepts EventHookHeaderArgs and EventHookHeaderOutput values. You can construct a concrete instance of `EventHookHeaderInput` via: 

EventHookHeaderArgs{...}

type EventHookHeaderOutput added in v2.4.0 

type EventHookHeaderOutput struct{ *pulumi.OutputState }

func (EventHookHeaderOutput) ElementType added in v2.4.0 

func (EventHookHeaderOutput) ElementType() reflect.Type

func (EventHookHeaderOutput) Key added in v2.4.0 

func (o EventHookHeaderOutput) Key() pulumi.StringPtrOutput

Key to use for authentication, usually the header name, for example `"Authorization"`.

func (EventHookHeaderOutput) ToEventHookHeaderOutput added in v2.4.0 

func (o EventHookHeaderOutput) ToEventHookHeaderOutput() EventHookHeaderOutput

func (EventHookHeaderOutput) ToEventHookHeaderOutputWithContext added in v2.4.0 

func (o EventHookHeaderOutput) ToEventHookHeaderOutputWithContext(ctx context.Context) EventHookHeaderOutput

func (EventHookHeaderOutput) Value added in v2.4.0 

func (o EventHookHeaderOutput) Value() pulumi.StringPtrOutput

Authentication secret.

type EventHookState added in v2.4.0 

type EventHookState struct {
	// Authentication required for event hook request.
	Auth EventHookAuthPtrInput
	// Details of the endpoint the event hook will hit.
	Channel EventHookChannelPtrInput
	// The events that will be delivered to this hook. [See here for a list of supported events](https://developer.okta.com/docs/reference/api/event-types/?q=event-hook-eligible).
	Events pulumi.StringArrayInput
	// Map of headers to send along in event hook request.
	Headers EventHookHeaderArrayInput
	// The event hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
}

func (EventHookState) ElementType added in v2.4.0 

func (EventHookState) ElementType() reflect.Type

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the okta package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

type ProviderArgs 

type ProviderArgs struct {
	// API Token granting privileges to Okta API.
	ApiToken pulumi.StringPtrInput
	// Use exponential back off strategy for rate limits.
	Backoff pulumi.BoolPtrInput
	// The Okta url. (Use 'oktapreview.com' for Okta testing)
	BaseUrl pulumi.StringPtrInput
	// maximum number of retries to attempt before erroring out.
	MaxRetries pulumi.IntPtrInput
	// maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
	MaxWaitSeconds pulumi.IntPtrInput
	// minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
	MinWaitSeconds pulumi.IntPtrInput
	// The organization to manage in Okta.
	OrgName pulumi.StringPtrInput
	// Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of
	// https://developer.okta.com/docs/api/getting_started/rate-limits.
	Parallelism pulumi.IntPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type TemplateSms added in v2.4.0 

type TemplateSms struct {
	pulumi.CustomResourceState

	// The SMS message.
	Template pulumi.StringOutput `pulumi:"template"`
	// Set of translations for particular template.
	Translations TemplateSmsTranslationArrayOutput `pulumi:"translations"`
	// SMS template type
	Type pulumi.StringOutput `pulumi:"type"`
}

Creates an Okta SMS Template.

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

## Example Usage

```go package main

import ( 

"fmt"

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewTemplateSms(ctx, "example", &okta.TemplateSmsArgs{
			Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Your ", org.Name, " code is: ", code)),
			Translations: okta.TemplateSmsTranslationArray{
				&okta.TemplateSmsTranslationArgs{
					Language: pulumi.String("en"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v", "Your ", org.Name, " code is: ", code)),
				},
				&okta.TemplateSmsTranslationArgs{
					Language: pulumi.String("es"),
					Template: pulumi.String(fmt.Sprintf("%v%v%v%v%v", "Tu código de ", org.Name, " es: ", code, ".")),
				},
			},
			Type: pulumi.String("SMS_VERIFY_CODE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetTemplateSms added in v2.4.0 

func GetTemplateSms(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateSmsState, opts ...pulumi.ResourceOption) (*TemplateSms, error)

GetTemplateSms gets an existing TemplateSms 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 NewTemplateSms added in v2.4.0 

func NewTemplateSms(ctx *pulumi.Context,
	name string, args *TemplateSmsArgs, opts ...pulumi.ResourceOption) (*TemplateSms, error)

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

type TemplateSmsArgs added in v2.4.0 

type TemplateSmsArgs struct {
	// The SMS message.
	Template pulumi.StringInput
	// Set of translations for particular template.
	Translations TemplateSmsTranslationArrayInput
	// SMS template type
	Type pulumi.StringInput
}

The set of arguments for constructing a TemplateSms resource.

func (TemplateSmsArgs) ElementType added in v2.4.0 

func (TemplateSmsArgs) ElementType() reflect.Type

type TemplateSmsState added in v2.4.0 

type TemplateSmsState struct {
	// The SMS message.
	Template pulumi.StringPtrInput
	// Set of translations for particular template.
	Translations TemplateSmsTranslationArrayInput
	// SMS template type
	Type pulumi.StringPtrInput
}

func (TemplateSmsState) ElementType added in v2.4.0 

func (TemplateSmsState) ElementType() reflect.Type

type TemplateSmsTranslation added in v2.4.0 

type TemplateSmsTranslation struct {
	// The language to map the template to.
	Language string `pulumi:"language"`
	// The SMS message.
	Template string `pulumi:"template"`
}

type TemplateSmsTranslationArgs added in v2.4.0 

type TemplateSmsTranslationArgs struct {
	// The language to map the template to.
	Language pulumi.StringInput `pulumi:"language"`
	// The SMS message.
	Template pulumi.StringInput `pulumi:"template"`
}

func (TemplateSmsTranslationArgs) ElementType added in v2.4.0 

func (TemplateSmsTranslationArgs) ElementType() reflect.Type

func (TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutput added in v2.4.0 

func (i TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput

func (TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutputWithContext added in v2.4.0 

func (i TemplateSmsTranslationArgs) ToTemplateSmsTranslationOutputWithContext(ctx context.Context) TemplateSmsTranslationOutput

type TemplateSmsTranslationArray added in v2.4.0 

type TemplateSmsTranslationArray []TemplateSmsTranslationInput

func (TemplateSmsTranslationArray) ElementType added in v2.4.0 

func (TemplateSmsTranslationArray) ElementType() reflect.Type

func (TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutput added in v2.4.0 

func (i TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput

func (TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutputWithContext added in v2.4.0 

func (i TemplateSmsTranslationArray) ToTemplateSmsTranslationArrayOutputWithContext(ctx context.Context) TemplateSmsTranslationArrayOutput

type TemplateSmsTranslationArrayInput added in v2.4.0 

type TemplateSmsTranslationArrayInput interface {
	pulumi.Input

	ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput
	ToTemplateSmsTranslationArrayOutputWithContext(context.Context) TemplateSmsTranslationArrayOutput
}

TemplateSmsTranslationArrayInput is an input type that accepts TemplateSmsTranslationArray and TemplateSmsTranslationArrayOutput values. You can construct a concrete instance of `TemplateSmsTranslationArrayInput` via: 

TemplateSmsTranslationArray{ TemplateSmsTranslationArgs{...} }

type TemplateSmsTranslationArrayOutput added in v2.4.0 

type TemplateSmsTranslationArrayOutput struct{ *pulumi.OutputState }

func (TemplateSmsTranslationArrayOutput) ElementType added in v2.4.0 

func (TemplateSmsTranslationArrayOutput) ElementType() reflect.Type

func (TemplateSmsTranslationArrayOutput) Index added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) Index(i pulumi.IntInput) TemplateSmsTranslationOutput

func (TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutput added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutput() TemplateSmsTranslationArrayOutput

func (TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutputWithContext added in v2.4.0 

func (o TemplateSmsTranslationArrayOutput) ToTemplateSmsTranslationArrayOutputWithContext(ctx context.Context) TemplateSmsTranslationArrayOutput

type TemplateSmsTranslationInput added in v2.4.0 

type TemplateSmsTranslationInput interface {
	pulumi.Input

	ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput
	ToTemplateSmsTranslationOutputWithContext(context.Context) TemplateSmsTranslationOutput
}

TemplateSmsTranslationInput is an input type that accepts TemplateSmsTranslationArgs and TemplateSmsTranslationOutput values. You can construct a concrete instance of `TemplateSmsTranslationInput` via: 

TemplateSmsTranslationArgs{...}

type TemplateSmsTranslationOutput added in v2.4.0 

type TemplateSmsTranslationOutput struct{ *pulumi.OutputState }

func (TemplateSmsTranslationOutput) ElementType added in v2.4.0 

func (TemplateSmsTranslationOutput) ElementType() reflect.Type

func (TemplateSmsTranslationOutput) Language added in v2.4.0 

func (o TemplateSmsTranslationOutput) Language() pulumi.StringOutput

The language to map the template to.

func (TemplateSmsTranslationOutput) Template added in v2.4.0 

func (o TemplateSmsTranslationOutput) Template() pulumi.StringOutput

The SMS message.

func (TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutput added in v2.4.0 

func (o TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutput() TemplateSmsTranslationOutput

func (TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutputWithContext added in v2.4.0 

func (o TemplateSmsTranslationOutput) ToTemplateSmsTranslationOutputWithContext(ctx context.Context) TemplateSmsTranslationOutput

Source Files

View all Source files

Directories

Path Synopsis

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.