index

package
v4.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2023 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 EmailDomain added in v4.0.3 

type EmailDomain struct {
	pulumi.CustomResourceState

	// Brand id of the email domain.
	BrandId pulumi.StringOutput `pulumi:"brandId"`
	// Display name of the email domain.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// TXT and CNAME records to be registered for the domain.
	DnsValidationRecords EmailDomainDnsValidationRecordArrayOutput `pulumi:"dnsValidationRecords"`
	// Mail domain to send from.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// User name of the email domain.
	UserName pulumi.StringOutput `pulumi:"userName"`
	// Status of the email domain (shows whether the domain is verified).
	ValidationStatus pulumi.StringOutput `pulumi:"validationStatus"`
}

This resource allows you to create and configure an email domain.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/Index"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Index.NewEmailDomain(ctx, "example", &Index.EmailDomainArgs{
			BrandId:     pulumi.String("abc123"),
			DisplayName: pulumi.String("test"),
			Domain:      pulumi.String("example.com"),
			UserName:    pulumi.String("paul_atreides"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Custom email domain can be imported via the Okta ID.

```sh 

$ pulumi import okta:Index/emailDomain:EmailDomain example <domain id>

```

func GetEmailDomain added in v4.0.3 

func GetEmailDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EmailDomainState, opts ...pulumi.ResourceOption) (*EmailDomain, error)

GetEmailDomain gets an existing EmailDomain 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 NewEmailDomain added in v4.0.3 

func NewEmailDomain(ctx *pulumi.Context,
	name string, args *EmailDomainArgs, opts ...pulumi.ResourceOption) (*EmailDomain, error)

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

func (*EmailDomain) ElementType added in v4.0.3 

func (*EmailDomain) ElementType() reflect.Type

func (*EmailDomain) ToEmailDomainOutput added in v4.0.3 

func (i *EmailDomain) ToEmailDomainOutput() EmailDomainOutput

func (*EmailDomain) ToEmailDomainOutputWithContext added in v4.0.3 

func (i *EmailDomain) ToEmailDomainOutputWithContext(ctx context.Context) EmailDomainOutput

type EmailDomainArgs added in v4.0.3 

type EmailDomainArgs struct {
	// Brand id of the email domain.
	BrandId pulumi.StringInput
	// Display name of the email domain.
	DisplayName pulumi.StringInput
	// Mail domain to send from.
	Domain pulumi.StringInput
	// User name of the email domain.
	UserName pulumi.StringInput
}

The set of arguments for constructing a EmailDomain resource.

func (EmailDomainArgs) ElementType added in v4.0.3 

func (EmailDomainArgs) ElementType() reflect.Type

type EmailDomainArray added in v4.0.3 

type EmailDomainArray []EmailDomainInput

func (EmailDomainArray) ElementType added in v4.0.3 

func (EmailDomainArray) ElementType() reflect.Type

func (EmailDomainArray) ToEmailDomainArrayOutput added in v4.0.3 

func (i EmailDomainArray) ToEmailDomainArrayOutput() EmailDomainArrayOutput

func (EmailDomainArray) ToEmailDomainArrayOutputWithContext added in v4.0.3 

func (i EmailDomainArray) ToEmailDomainArrayOutputWithContext(ctx context.Context) EmailDomainArrayOutput

type EmailDomainArrayInput added in v4.0.3 

type EmailDomainArrayInput interface {
	pulumi.Input

	ToEmailDomainArrayOutput() EmailDomainArrayOutput
	ToEmailDomainArrayOutputWithContext(context.Context) EmailDomainArrayOutput
}

EmailDomainArrayInput is an input type that accepts EmailDomainArray and EmailDomainArrayOutput values. You can construct a concrete instance of `EmailDomainArrayInput` via: 

EmailDomainArray{ EmailDomainArgs{...} }

type EmailDomainArrayOutput added in v4.0.3 

type EmailDomainArrayOutput struct{ *pulumi.OutputState }

func (EmailDomainArrayOutput) ElementType added in v4.0.3 

func (EmailDomainArrayOutput) ElementType() reflect.Type

func (EmailDomainArrayOutput) Index added in v4.0.3 

func (o EmailDomainArrayOutput) Index(i pulumi.IntInput) EmailDomainOutput

func (EmailDomainArrayOutput) ToEmailDomainArrayOutput added in v4.0.3 

func (o EmailDomainArrayOutput) ToEmailDomainArrayOutput() EmailDomainArrayOutput

func (EmailDomainArrayOutput) ToEmailDomainArrayOutputWithContext added in v4.0.3 

func (o EmailDomainArrayOutput) ToEmailDomainArrayOutputWithContext(ctx context.Context) EmailDomainArrayOutput

type EmailDomainDnsValidationRecord added in v4.0.3 

type EmailDomainDnsValidationRecord struct {
	Expiration *string `pulumi:"expiration"`
	// DNS record name.
	Fqdn *string `pulumi:"fqdn"`
	// Record type can be TXT or cname.
	RecordType *string `pulumi:"recordType"`
	// DNS record value
	// - ` expiration  ` - DNS TXT record expiration
	Value *string `pulumi:"value"`
}

type EmailDomainDnsValidationRecordArgs added in v4.0.3 

type EmailDomainDnsValidationRecordArgs struct {
	Expiration pulumi.StringPtrInput `pulumi:"expiration"`
	// DNS record name.
	Fqdn pulumi.StringPtrInput `pulumi:"fqdn"`
	// Record type can be TXT or cname.
	RecordType pulumi.StringPtrInput `pulumi:"recordType"`
	// DNS record value
	// - ` expiration  ` - DNS TXT record expiration
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (EmailDomainDnsValidationRecordArgs) ElementType added in v4.0.3 

func (EmailDomainDnsValidationRecordArgs) ElementType() reflect.Type

func (EmailDomainDnsValidationRecordArgs) ToEmailDomainDnsValidationRecordOutput added in v4.0.3 

func (i EmailDomainDnsValidationRecordArgs) ToEmailDomainDnsValidationRecordOutput() EmailDomainDnsValidationRecordOutput

func (EmailDomainDnsValidationRecordArgs) ToEmailDomainDnsValidationRecordOutputWithContext added in v4.0.3 

func (i EmailDomainDnsValidationRecordArgs) ToEmailDomainDnsValidationRecordOutputWithContext(ctx context.Context) EmailDomainDnsValidationRecordOutput

type EmailDomainDnsValidationRecordArray added in v4.0.3 

type EmailDomainDnsValidationRecordArray []EmailDomainDnsValidationRecordInput

func (EmailDomainDnsValidationRecordArray) ElementType added in v4.0.3 

func (EmailDomainDnsValidationRecordArray) ElementType() reflect.Type

func (EmailDomainDnsValidationRecordArray) ToEmailDomainDnsValidationRecordArrayOutput added in v4.0.3 

func (i EmailDomainDnsValidationRecordArray) ToEmailDomainDnsValidationRecordArrayOutput() EmailDomainDnsValidationRecordArrayOutput

func (EmailDomainDnsValidationRecordArray) ToEmailDomainDnsValidationRecordArrayOutputWithContext added in v4.0.3 

func (i EmailDomainDnsValidationRecordArray) ToEmailDomainDnsValidationRecordArrayOutputWithContext(ctx context.Context) EmailDomainDnsValidationRecordArrayOutput

type EmailDomainDnsValidationRecordArrayInput added in v4.0.3 

type EmailDomainDnsValidationRecordArrayInput interface {
	pulumi.Input

	ToEmailDomainDnsValidationRecordArrayOutput() EmailDomainDnsValidationRecordArrayOutput
	ToEmailDomainDnsValidationRecordArrayOutputWithContext(context.Context) EmailDomainDnsValidationRecordArrayOutput
}

EmailDomainDnsValidationRecordArrayInput is an input type that accepts EmailDomainDnsValidationRecordArray and EmailDomainDnsValidationRecordArrayOutput values. You can construct a concrete instance of `EmailDomainDnsValidationRecordArrayInput` via: 

EmailDomainDnsValidationRecordArray{ EmailDomainDnsValidationRecordArgs{...} }

type EmailDomainDnsValidationRecordArrayOutput added in v4.0.3 

type EmailDomainDnsValidationRecordArrayOutput struct{ *pulumi.OutputState }

func (EmailDomainDnsValidationRecordArrayOutput) ElementType added in v4.0.3 

func (EmailDomainDnsValidationRecordArrayOutput) ElementType() reflect.Type

func (EmailDomainDnsValidationRecordArrayOutput) Index added in v4.0.3 

func (o EmailDomainDnsValidationRecordArrayOutput) Index(i pulumi.IntInput) EmailDomainDnsValidationRecordOutput

func (EmailDomainDnsValidationRecordArrayOutput) ToEmailDomainDnsValidationRecordArrayOutput added in v4.0.3 

func (o EmailDomainDnsValidationRecordArrayOutput) ToEmailDomainDnsValidationRecordArrayOutput() EmailDomainDnsValidationRecordArrayOutput

func (EmailDomainDnsValidationRecordArrayOutput) ToEmailDomainDnsValidationRecordArrayOutputWithContext added in v4.0.3 

func (o EmailDomainDnsValidationRecordArrayOutput) ToEmailDomainDnsValidationRecordArrayOutputWithContext(ctx context.Context) EmailDomainDnsValidationRecordArrayOutput

type EmailDomainDnsValidationRecordInput added in v4.0.3 

type EmailDomainDnsValidationRecordInput interface {
	pulumi.Input

	ToEmailDomainDnsValidationRecordOutput() EmailDomainDnsValidationRecordOutput
	ToEmailDomainDnsValidationRecordOutputWithContext(context.Context) EmailDomainDnsValidationRecordOutput
}

EmailDomainDnsValidationRecordInput is an input type that accepts EmailDomainDnsValidationRecordArgs and EmailDomainDnsValidationRecordOutput values. You can construct a concrete instance of `EmailDomainDnsValidationRecordInput` via: 

EmailDomainDnsValidationRecordArgs{...}

type EmailDomainDnsValidationRecordOutput added in v4.0.3 

type EmailDomainDnsValidationRecordOutput struct{ *pulumi.OutputState }

func (EmailDomainDnsValidationRecordOutput) ElementType added in v4.0.3 

func (EmailDomainDnsValidationRecordOutput) ElementType() reflect.Type

func (EmailDomainDnsValidationRecordOutput) Expiration added in v4.0.3 

func (o EmailDomainDnsValidationRecordOutput) Expiration() pulumi.StringPtrOutput

func (EmailDomainDnsValidationRecordOutput) Fqdn added in v4.0.3 

func (o EmailDomainDnsValidationRecordOutput) Fqdn() pulumi.StringPtrOutput

DNS record name.

func (EmailDomainDnsValidationRecordOutput) RecordType added in v4.0.3 

func (o EmailDomainDnsValidationRecordOutput) RecordType() pulumi.StringPtrOutput

Record type can be TXT or cname.

func (EmailDomainDnsValidationRecordOutput) ToEmailDomainDnsValidationRecordOutput added in v4.0.3 

func (o EmailDomainDnsValidationRecordOutput) ToEmailDomainDnsValidationRecordOutput() EmailDomainDnsValidationRecordOutput

func (EmailDomainDnsValidationRecordOutput) ToEmailDomainDnsValidationRecordOutputWithContext added in v4.0.3 

func (o EmailDomainDnsValidationRecordOutput) ToEmailDomainDnsValidationRecordOutputWithContext(ctx context.Context) EmailDomainDnsValidationRecordOutput

func (EmailDomainDnsValidationRecordOutput) Value added in v4.0.5 

func (o EmailDomainDnsValidationRecordOutput) Value() pulumi.StringPtrOutput

DNS record value - ` expiration ` - DNS TXT record expiration

type EmailDomainInput added in v4.0.3 

type EmailDomainInput interface {
	pulumi.Input

	ToEmailDomainOutput() EmailDomainOutput
	ToEmailDomainOutputWithContext(ctx context.Context) EmailDomainOutput
}

type EmailDomainMap added in v4.0.3 

type EmailDomainMap map[string]EmailDomainInput

func (EmailDomainMap) ElementType added in v4.0.3 

func (EmailDomainMap) ElementType() reflect.Type

func (EmailDomainMap) ToEmailDomainMapOutput added in v4.0.3 

func (i EmailDomainMap) ToEmailDomainMapOutput() EmailDomainMapOutput

func (EmailDomainMap) ToEmailDomainMapOutputWithContext added in v4.0.3 

func (i EmailDomainMap) ToEmailDomainMapOutputWithContext(ctx context.Context) EmailDomainMapOutput

type EmailDomainMapInput added in v4.0.3 

type EmailDomainMapInput interface {
	pulumi.Input

	ToEmailDomainMapOutput() EmailDomainMapOutput
	ToEmailDomainMapOutputWithContext(context.Context) EmailDomainMapOutput
}

EmailDomainMapInput is an input type that accepts EmailDomainMap and EmailDomainMapOutput values. You can construct a concrete instance of `EmailDomainMapInput` via: 

EmailDomainMap{ "key": EmailDomainArgs{...} }

type EmailDomainMapOutput added in v4.0.3 

type EmailDomainMapOutput struct{ *pulumi.OutputState }

func (EmailDomainMapOutput) ElementType added in v4.0.3 

func (EmailDomainMapOutput) ElementType() reflect.Type

func (EmailDomainMapOutput) MapIndex added in v4.0.3 

func (o EmailDomainMapOutput) MapIndex(k pulumi.StringInput) EmailDomainOutput

func (EmailDomainMapOutput) ToEmailDomainMapOutput added in v4.0.3 

func (o EmailDomainMapOutput) ToEmailDomainMapOutput() EmailDomainMapOutput

func (EmailDomainMapOutput) ToEmailDomainMapOutputWithContext added in v4.0.3 

func (o EmailDomainMapOutput) ToEmailDomainMapOutputWithContext(ctx context.Context) EmailDomainMapOutput

type EmailDomainOutput added in v4.0.3 

type EmailDomainOutput struct{ *pulumi.OutputState }

func (EmailDomainOutput) BrandId added in v4.0.3 

func (o EmailDomainOutput) BrandId() pulumi.StringOutput

Brand id of the email domain.

func (EmailDomainOutput) DisplayName added in v4.0.3 

func (o EmailDomainOutput) DisplayName() pulumi.StringOutput

Display name of the email domain.

func (EmailDomainOutput) DnsValidationRecords added in v4.0.3 

func (o EmailDomainOutput) DnsValidationRecords() EmailDomainDnsValidationRecordArrayOutput

TXT and CNAME records to be registered for the domain.

func (EmailDomainOutput) Domain added in v4.0.3 

func (o EmailDomainOutput) Domain() pulumi.StringOutput

Mail domain to send from.

func (EmailDomainOutput) ElementType added in v4.0.3 

func (EmailDomainOutput) ElementType() reflect.Type

func (EmailDomainOutput) ToEmailDomainOutput added in v4.0.3 

func (o EmailDomainOutput) ToEmailDomainOutput() EmailDomainOutput

func (EmailDomainOutput) ToEmailDomainOutputWithContext added in v4.0.3 

func (o EmailDomainOutput) ToEmailDomainOutputWithContext(ctx context.Context) EmailDomainOutput

func (EmailDomainOutput) UserName added in v4.0.3 

func (o EmailDomainOutput) UserName() pulumi.StringOutput

User name of the email domain.

func (EmailDomainOutput) ValidationStatus added in v4.0.3 

func (o EmailDomainOutput) ValidationStatus() pulumi.StringOutput

Status of the email domain (shows whether the domain is verified).

type EmailDomainState added in v4.0.3 

type EmailDomainState struct {
	// Brand id of the email domain.
	BrandId pulumi.StringPtrInput
	// Display name of the email domain.
	DisplayName pulumi.StringPtrInput
	// TXT and CNAME records to be registered for the domain.
	DnsValidationRecords EmailDomainDnsValidationRecordArrayInput
	// Mail domain to send from.
	Domain pulumi.StringPtrInput
	// User name of the email domain.
	UserName pulumi.StringPtrInput
	// Status of the email domain (shows whether the domain is verified).
	ValidationStatus pulumi.StringPtrInput
}

func (EmailDomainState) ElementType added in v4.0.3 

func (EmailDomainState) ElementType() reflect.Type

type EmailDomainVerification added in v4.0.3 

type EmailDomainVerification struct {
	pulumi.CustomResourceState

	// Email domain ID.
	EmailDomainId pulumi.StringOutput `pulumi:"emailDomainId"`
}

Verifies the email domain. The resource won't be created if the email domain could not be verified.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/Index"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Index.NewEmailDomain(ctx, "exampleEmailDomain", &Index.EmailDomainArgs{
			BrandId:     pulumi.String("abc123"),
			Domain:      pulumi.String("example.com"),
			DisplayName: pulumi.String("test"),
			UserName:    pulumi.String("paul_atreides"),
		})
		if err != nil {
			return err
		}
		_, err = Index.NewEmailDomainVerification(ctx, "exampleEmailDomainVerification", &Index.EmailDomainVerificationArgs{
			EmailDomainId: pulumi.Any(okta_email_domain.Valid.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

This resource does not support importing.

func GetEmailDomainVerification added in v4.0.3 

func GetEmailDomainVerification(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EmailDomainVerificationState, opts ...pulumi.ResourceOption) (*EmailDomainVerification, error)

GetEmailDomainVerification gets an existing EmailDomainVerification 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 NewEmailDomainVerification added in v4.0.3 

func NewEmailDomainVerification(ctx *pulumi.Context,
	name string, args *EmailDomainVerificationArgs, opts ...pulumi.ResourceOption) (*EmailDomainVerification, error)

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

func (*EmailDomainVerification) ElementType added in v4.0.3 

func (*EmailDomainVerification) ElementType() reflect.Type

func (*EmailDomainVerification) ToEmailDomainVerificationOutput added in v4.0.3 

func (i *EmailDomainVerification) ToEmailDomainVerificationOutput() EmailDomainVerificationOutput

func (*EmailDomainVerification) ToEmailDomainVerificationOutputWithContext added in v4.0.3 

func (i *EmailDomainVerification) ToEmailDomainVerificationOutputWithContext(ctx context.Context) EmailDomainVerificationOutput

type EmailDomainVerificationArgs added in v4.0.3 

type EmailDomainVerificationArgs struct {
	// Email domain ID.
	EmailDomainId pulumi.StringInput
}

The set of arguments for constructing a EmailDomainVerification resource.

func (EmailDomainVerificationArgs) ElementType added in v4.0.3 

func (EmailDomainVerificationArgs) ElementType() reflect.Type

type EmailDomainVerificationArray added in v4.0.3 

type EmailDomainVerificationArray []EmailDomainVerificationInput

func (EmailDomainVerificationArray) ElementType added in v4.0.3 

func (EmailDomainVerificationArray) ElementType() reflect.Type

func (EmailDomainVerificationArray) ToEmailDomainVerificationArrayOutput added in v4.0.3 

func (i EmailDomainVerificationArray) ToEmailDomainVerificationArrayOutput() EmailDomainVerificationArrayOutput

func (EmailDomainVerificationArray) ToEmailDomainVerificationArrayOutputWithContext added in v4.0.3 

func (i EmailDomainVerificationArray) ToEmailDomainVerificationArrayOutputWithContext(ctx context.Context) EmailDomainVerificationArrayOutput

type EmailDomainVerificationArrayInput added in v4.0.3 

type EmailDomainVerificationArrayInput interface {
	pulumi.Input

	ToEmailDomainVerificationArrayOutput() EmailDomainVerificationArrayOutput
	ToEmailDomainVerificationArrayOutputWithContext(context.Context) EmailDomainVerificationArrayOutput
}

EmailDomainVerificationArrayInput is an input type that accepts EmailDomainVerificationArray and EmailDomainVerificationArrayOutput values. You can construct a concrete instance of `EmailDomainVerificationArrayInput` via: 

EmailDomainVerificationArray{ EmailDomainVerificationArgs{...} }

type EmailDomainVerificationArrayOutput added in v4.0.3 

type EmailDomainVerificationArrayOutput struct{ *pulumi.OutputState }

func (EmailDomainVerificationArrayOutput) ElementType added in v4.0.3 

func (EmailDomainVerificationArrayOutput) ElementType() reflect.Type

func (EmailDomainVerificationArrayOutput) Index added in v4.0.3 

func (o EmailDomainVerificationArrayOutput) Index(i pulumi.IntInput) EmailDomainVerificationOutput

func (EmailDomainVerificationArrayOutput) ToEmailDomainVerificationArrayOutput added in v4.0.3 

func (o EmailDomainVerificationArrayOutput) ToEmailDomainVerificationArrayOutput() EmailDomainVerificationArrayOutput

func (EmailDomainVerificationArrayOutput) ToEmailDomainVerificationArrayOutputWithContext added in v4.0.3 

func (o EmailDomainVerificationArrayOutput) ToEmailDomainVerificationArrayOutputWithContext(ctx context.Context) EmailDomainVerificationArrayOutput

type EmailDomainVerificationInput added in v4.0.3 

type EmailDomainVerificationInput interface {
	pulumi.Input

	ToEmailDomainVerificationOutput() EmailDomainVerificationOutput
	ToEmailDomainVerificationOutputWithContext(ctx context.Context) EmailDomainVerificationOutput
}

type EmailDomainVerificationMap added in v4.0.3 

type EmailDomainVerificationMap map[string]EmailDomainVerificationInput

func (EmailDomainVerificationMap) ElementType added in v4.0.3 

func (EmailDomainVerificationMap) ElementType() reflect.Type

func (EmailDomainVerificationMap) ToEmailDomainVerificationMapOutput added in v4.0.3 

func (i EmailDomainVerificationMap) ToEmailDomainVerificationMapOutput() EmailDomainVerificationMapOutput

func (EmailDomainVerificationMap) ToEmailDomainVerificationMapOutputWithContext added in v4.0.3 

func (i EmailDomainVerificationMap) ToEmailDomainVerificationMapOutputWithContext(ctx context.Context) EmailDomainVerificationMapOutput

type EmailDomainVerificationMapInput added in v4.0.3 

type EmailDomainVerificationMapInput interface {
	pulumi.Input

	ToEmailDomainVerificationMapOutput() EmailDomainVerificationMapOutput
	ToEmailDomainVerificationMapOutputWithContext(context.Context) EmailDomainVerificationMapOutput
}

EmailDomainVerificationMapInput is an input type that accepts EmailDomainVerificationMap and EmailDomainVerificationMapOutput values. You can construct a concrete instance of `EmailDomainVerificationMapInput` via: 

EmailDomainVerificationMap{ "key": EmailDomainVerificationArgs{...} }

type EmailDomainVerificationMapOutput added in v4.0.3 

type EmailDomainVerificationMapOutput struct{ *pulumi.OutputState }

func (EmailDomainVerificationMapOutput) ElementType added in v4.0.3 

func (EmailDomainVerificationMapOutput) ElementType() reflect.Type

func (EmailDomainVerificationMapOutput) MapIndex added in v4.0.3 

func (o EmailDomainVerificationMapOutput) MapIndex(k pulumi.StringInput) EmailDomainVerificationOutput

func (EmailDomainVerificationMapOutput) ToEmailDomainVerificationMapOutput added in v4.0.3 

func (o EmailDomainVerificationMapOutput) ToEmailDomainVerificationMapOutput() EmailDomainVerificationMapOutput

func (EmailDomainVerificationMapOutput) ToEmailDomainVerificationMapOutputWithContext added in v4.0.3 

func (o EmailDomainVerificationMapOutput) ToEmailDomainVerificationMapOutputWithContext(ctx context.Context) EmailDomainVerificationMapOutput

type EmailDomainVerificationOutput added in v4.0.3 

type EmailDomainVerificationOutput struct{ *pulumi.OutputState }

func (EmailDomainVerificationOutput) ElementType added in v4.0.3 

func (EmailDomainVerificationOutput) ElementType() reflect.Type

func (EmailDomainVerificationOutput) EmailDomainId added in v4.0.3 

func (o EmailDomainVerificationOutput) EmailDomainId() pulumi.StringOutput

Email domain ID.

func (EmailDomainVerificationOutput) ToEmailDomainVerificationOutput added in v4.0.3 

func (o EmailDomainVerificationOutput) ToEmailDomainVerificationOutput() EmailDomainVerificationOutput

func (EmailDomainVerificationOutput) ToEmailDomainVerificationOutputWithContext added in v4.0.3 

func (o EmailDomainVerificationOutput) ToEmailDomainVerificationOutputWithContext(ctx context.Context) EmailDomainVerificationOutput

type EmailDomainVerificationState added in v4.0.3 

type EmailDomainVerificationState struct {
	// Email domain ID.
	EmailDomainId pulumi.StringPtrInput
}

func (EmailDomainVerificationState) ElementType added in v4.0.3 

func (EmailDomainVerificationState) ElementType() reflect.Type

type GetDomainArgs 

type GetDomainArgs struct {
	// The Okta ID of the domain or the domain name itself.
	DomainIdOrName string `pulumi:"domainIdOrName"`
}

A collection of arguments for invoking getDomain.

type GetDomainDnsRecord 

type GetDomainDnsRecord struct {
	// TXT record expiration.
	Expiration string `pulumi:"expiration"`
	// DNS record name.
	Fqdn string `pulumi:"fqdn"`
	// Record type can be TXT or CNAME.
	RecordType string `pulumi:"recordType"`
	// DNS verification value
	Values []string `pulumi:"values"`
}

type GetDomainDnsRecordArgs 

type GetDomainDnsRecordArgs struct {
	// TXT record expiration.
	Expiration pulumi.StringInput `pulumi:"expiration"`
	// DNS record name.
	Fqdn pulumi.StringInput `pulumi:"fqdn"`
	// Record type can be TXT or CNAME.
	RecordType pulumi.StringInput `pulumi:"recordType"`
	// DNS verification value
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetDomainDnsRecordArgs) ElementType 

func (GetDomainDnsRecordArgs) ElementType() reflect.Type

func (GetDomainDnsRecordArgs) ToGetDomainDnsRecordOutput 

func (i GetDomainDnsRecordArgs) ToGetDomainDnsRecordOutput() GetDomainDnsRecordOutput

func (GetDomainDnsRecordArgs) ToGetDomainDnsRecordOutputWithContext 

func (i GetDomainDnsRecordArgs) ToGetDomainDnsRecordOutputWithContext(ctx context.Context) GetDomainDnsRecordOutput

type GetDomainDnsRecordArray 

type GetDomainDnsRecordArray []GetDomainDnsRecordInput

func (GetDomainDnsRecordArray) ElementType 

func (GetDomainDnsRecordArray) ElementType() reflect.Type

func (GetDomainDnsRecordArray) ToGetDomainDnsRecordArrayOutput 

func (i GetDomainDnsRecordArray) ToGetDomainDnsRecordArrayOutput() GetDomainDnsRecordArrayOutput

func (GetDomainDnsRecordArray) ToGetDomainDnsRecordArrayOutputWithContext 

func (i GetDomainDnsRecordArray) ToGetDomainDnsRecordArrayOutputWithContext(ctx context.Context) GetDomainDnsRecordArrayOutput

type GetDomainDnsRecordArrayInput 

type GetDomainDnsRecordArrayInput interface {
	pulumi.Input

	ToGetDomainDnsRecordArrayOutput() GetDomainDnsRecordArrayOutput
	ToGetDomainDnsRecordArrayOutputWithContext(context.Context) GetDomainDnsRecordArrayOutput
}

GetDomainDnsRecordArrayInput is an input type that accepts GetDomainDnsRecordArray and GetDomainDnsRecordArrayOutput values. You can construct a concrete instance of `GetDomainDnsRecordArrayInput` via: 

GetDomainDnsRecordArray{ GetDomainDnsRecordArgs{...} }

type GetDomainDnsRecordArrayOutput 

type GetDomainDnsRecordArrayOutput struct{ *pulumi.OutputState }

func (GetDomainDnsRecordArrayOutput) ElementType 

func (GetDomainDnsRecordArrayOutput) ElementType() reflect.Type

func (GetDomainDnsRecordArrayOutput) Index 

func (o GetDomainDnsRecordArrayOutput) Index(i pulumi.IntInput) GetDomainDnsRecordOutput

func (GetDomainDnsRecordArrayOutput) ToGetDomainDnsRecordArrayOutput 

func (o GetDomainDnsRecordArrayOutput) ToGetDomainDnsRecordArrayOutput() GetDomainDnsRecordArrayOutput

func (GetDomainDnsRecordArrayOutput) ToGetDomainDnsRecordArrayOutputWithContext 

func (o GetDomainDnsRecordArrayOutput) ToGetDomainDnsRecordArrayOutputWithContext(ctx context.Context) GetDomainDnsRecordArrayOutput

type GetDomainDnsRecordInput 

type GetDomainDnsRecordInput interface {
	pulumi.Input

	ToGetDomainDnsRecordOutput() GetDomainDnsRecordOutput
	ToGetDomainDnsRecordOutputWithContext(context.Context) GetDomainDnsRecordOutput
}

GetDomainDnsRecordInput is an input type that accepts GetDomainDnsRecordArgs and GetDomainDnsRecordOutput values. You can construct a concrete instance of `GetDomainDnsRecordInput` via: 

GetDomainDnsRecordArgs{...}

type GetDomainDnsRecordOutput 

type GetDomainDnsRecordOutput struct{ *pulumi.OutputState }

func (GetDomainDnsRecordOutput) ElementType 

func (GetDomainDnsRecordOutput) ElementType() reflect.Type

func (GetDomainDnsRecordOutput) Expiration 

func (o GetDomainDnsRecordOutput) Expiration() pulumi.StringOutput

TXT record expiration.

func (GetDomainDnsRecordOutput) Fqdn 

func (o GetDomainDnsRecordOutput) Fqdn() pulumi.StringOutput

DNS record name.

func (GetDomainDnsRecordOutput) RecordType 

func (o GetDomainDnsRecordOutput) RecordType() pulumi.StringOutput

Record type can be TXT or CNAME.

func (GetDomainDnsRecordOutput) ToGetDomainDnsRecordOutput 

func (o GetDomainDnsRecordOutput) ToGetDomainDnsRecordOutput() GetDomainDnsRecordOutput

func (GetDomainDnsRecordOutput) ToGetDomainDnsRecordOutputWithContext 

func (o GetDomainDnsRecordOutput) ToGetDomainDnsRecordOutputWithContext(ctx context.Context) GetDomainDnsRecordOutput

func (GetDomainDnsRecordOutput) Values 

func (o GetDomainDnsRecordOutput) Values() pulumi.StringArrayOutput

DNS verification value

type GetDomainOutputArgs 

type GetDomainOutputArgs struct {
	// The Okta ID of the domain or the domain name itself.
	DomainIdOrName pulumi.StringInput `pulumi:"domainIdOrName"`
}

A collection of arguments for invoking getDomain.

func (GetDomainOutputArgs) ElementType 

func (GetDomainOutputArgs) ElementType() reflect.Type

type GetDomainResult 

type GetDomainResult struct {
	// Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED"
	CertificateSourceType string `pulumi:"certificateSourceType"`
	// TXT and CNAME records to be registered for the Domain.
	DnsRecords []GetDomainDnsRecord `pulumi:"dnsRecords"`
	// Domain name
	Domain         string `pulumi:"domain"`
	DomainIdOrName string `pulumi:"domainIdOrName"`
	// Domain ID
	Id string `pulumi:"id"`
	// Certificate metadata for the Domain
	PublicCertificate map[string]string `pulumi:"publicCertificate"`
	// Status of the domain. Values: `NOT_STARTED`, `IN_PROGRESS`, `VERIFIED`, `COMPLETED`
	ValidationStatus string `pulumi:"validationStatus"`
}

A collection of values returned by getDomain.

func GetDomain 

func GetDomain(ctx *pulumi.Context, args *GetDomainArgs, opts ...pulumi.InvokeOption) (*GetDomainResult, error)

Use this data source to retrieve a domain from Okta.

- https://developer.okta.com/docs/reference/api/domains/#get-domain - https://developer.okta.com/docs/reference/api/domains/#domainresponse-object

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/Index"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := okta.NewDomain(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = Index.GetDomain(ctx, &index.GetDomainArgs{
			DomainIdOrName: "www.example.com",
		}, nil)
		if err != nil {
			return err
		}
		_ = Index.GetDomainOutput(ctx, index.GetDomainOutputArgs{
			DomainIdOrName: example.ID(),
		}, nil)
		return nil
	})
}

```

type GetDomainResultOutput 

type GetDomainResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDomain.

func GetDomainOutput 

func GetDomainOutput(ctx *pulumi.Context, args GetDomainOutputArgs, opts ...pulumi.InvokeOption) GetDomainResultOutput

func (GetDomainResultOutput) CertificateSourceType 

func (o GetDomainResultOutput) CertificateSourceType() pulumi.StringOutput

Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED"

func (GetDomainResultOutput) DnsRecords 

func (o GetDomainResultOutput) DnsRecords() GetDomainDnsRecordArrayOutput

TXT and CNAME records to be registered for the Domain.

func (GetDomainResultOutput) Domain 

func (o GetDomainResultOutput) Domain() pulumi.StringOutput

Domain name

func (GetDomainResultOutput) DomainIdOrName 

func (o GetDomainResultOutput) DomainIdOrName() pulumi.StringOutput

func (GetDomainResultOutput) ElementType 

func (GetDomainResultOutput) ElementType() reflect.Type

func (GetDomainResultOutput) Id 

func (o GetDomainResultOutput) Id() pulumi.StringOutput

Domain ID

func (GetDomainResultOutput) PublicCertificate 

func (o GetDomainResultOutput) PublicCertificate() pulumi.StringMapOutput

Certificate metadata for the Domain

func (GetDomainResultOutput) ToGetDomainResultOutput 

func (o GetDomainResultOutput) ToGetDomainResultOutput() GetDomainResultOutput

func (GetDomainResultOutput) ToGetDomainResultOutputWithContext 

func (o GetDomainResultOutput) ToGetDomainResultOutputWithContext(ctx context.Context) GetDomainResultOutput

func (GetDomainResultOutput) ValidationStatus 

func (o GetDomainResultOutput) ValidationStatus() pulumi.StringOutput

Status of the domain. Values: `NOT_STARTED`, `IN_PROGRESS`, `VERIFIED`, `COMPLETED`

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.