index

package
v3.23.0 Latest Latest
Warning

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

Go to latest
Published: Apr 20, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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) Index

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

TXT record expiration.

func (GetDomainDnsRecordOutput) Fqdn

DNS record name.

func (GetDomainDnsRecordOutput) RecordType

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

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/v3/go/okta"
"github.com/pulumi/pulumi-okta/sdk/v3/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 (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

TXT and CNAME records to be registered for the Domain.

func (GetDomainResultOutput) Domain

Domain name

func (GetDomainResultOutput) DomainIdOrName

func (o GetDomainResultOutput) DomainIdOrName() pulumi.StringOutput

func (GetDomainResultOutput) ElementType

func (GetDomainResultOutput) ElementType() reflect.Type

func (GetDomainResultOutput) Id

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`

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL