Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. EmailDomain
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

okta.EmailDomain

Explore with Pulumi AI

okta logo
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.EmailDomain("example", {
    brandId: "abc123",
    domain: "example.com",
    displayName: "test",
    userName: "paul_atreides",
});

    import pulumi
import pulumi_okta as okta

example = okta.EmailDomain("example",
    brand_id="abc123",
    domain="example.com",
    display_name="test",
    user_name="paul_atreides")

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.EmailDomain("example", new()
    {
        BrandId = "abc123",
        Domain = "example.com",
        DisplayName = "test",
        UserName = "paul_atreides",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.EmailDomain;
import com.pulumi.okta.EmailDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new EmailDomain("example", EmailDomainArgs.builder()
            .brandId("abc123")
            .domain("example.com")
            .displayName("test")
            .userName("paul_atreides")
            .build());

    }
}

    resources:
  example:
    type: okta:EmailDomain
    properties:
      brandId: abc123
      domain: example.com
      displayName: test
      userName: paul_atreides

    Create EmailDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EmailDomain(name: string, args: EmailDomainArgs, opts?: CustomResourceOptions);
    @overload
def EmailDomain(resource_name: str,
                args: EmailDomainArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def EmailDomain(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                brand_id: Optional[str] = None,
                display_name: Optional[str] = None,
                domain: Optional[str] = None,
                user_name: Optional[str] = None)
    func NewEmailDomain(ctx *Context, name string, args EmailDomainArgs, opts ...ResourceOption) (*EmailDomain, error)
    public EmailDomain(string name, EmailDomainArgs args, CustomResourceOptions? opts = null)
    public EmailDomain(String name, EmailDomainArgs args)
public EmailDomain(String name, EmailDomainArgs args, CustomResourceOptions options)

    type: okta:EmailDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EmailDomainArgs
    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 EmailDomainArgs
    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 EmailDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var emailDomainResource = new Okta.EmailDomain("emailDomainResource", new()
{
    BrandId = "string",
    DisplayName = "string",
    Domain = "string",
    UserName = "string",
});

    example, err := okta.NewEmailDomain(ctx, "emailDomainResource", &okta.EmailDomainArgs{
	BrandId:     pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Domain:      pulumi.String("string"),
	UserName:    pulumi.String("string"),
})

    var emailDomainResource = new EmailDomain("emailDomainResource", EmailDomainArgs.builder()
    .brandId("string")
    .displayName("string")
    .domain("string")
    .userName("string")
    .build());

    email_domain_resource = okta.EmailDomain("emailDomainResource",
    brand_id="string",
    display_name="string",
    domain="string",
    user_name="string")

    const emailDomainResource = new okta.EmailDomain("emailDomainResource", {
    brandId: "string",
    displayName: "string",
    domain: "string",
    userName: "string",
});

    type: okta:EmailDomain
properties:
    brandId: string
    displayName: string
    domain: string
    userName: string

    EmailDomain 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 EmailDomain resource accepts the following input properties:

    BrandId string
    Brand id of the email domain.
    DisplayName string
    Display name of the email domain.
    Domain string
    Mail domain to send from.
    UserName string
    User name of the email domain.
    BrandId string
    Brand id of the email domain.
    DisplayName string
    Display name of the email domain.
    Domain string
    Mail domain to send from.
    UserName string
    User name of the email domain.
    brandId String
    Brand id of the email domain.
    displayName String
    Display name of the email domain.
    domain String
    Mail domain to send from.
    userName String
    User name of the email domain.
    brandId string
    Brand id of the email domain.
    displayName string
    Display name of the email domain.
    domain string
    Mail domain to send from.
    userName string
    User name of the email domain.
    brand_id str
    Brand id of the email domain.
    display_name str
    Display name of the email domain.
    domain str
    Mail domain to send from.
    user_name str
    User name of the email domain.
    brandId String
    Brand id of the email domain.
    displayName String
    Display name of the email domain.
    domain String
    Mail domain to send from.
    userName String
    User name of the email domain.

    Outputs

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

    DnsValidationRecords List<EmailDomainDnsValidationRecord>
    TXT and cname records to be registered for the email Domain
    Id string
    The provider-assigned unique ID for this managed resource.
    ValidationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    DnsValidationRecords []EmailDomainDnsValidationRecord
    TXT and cname records to be registered for the email Domain
    Id string
    The provider-assigned unique ID for this managed resource.
    ValidationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    dnsValidationRecords List<EmailDomainDnsValidationRecord>
    TXT and cname records to be registered for the email Domain
    id String
    The provider-assigned unique ID for this managed resource.
    validationStatus String
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    dnsValidationRecords EmailDomainDnsValidationRecord[]
    TXT and cname records to be registered for the email Domain
    id string
    The provider-assigned unique ID for this managed resource.
    validationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    dns_validation_records Sequence[EmailDomainDnsValidationRecord]
    TXT and cname records to be registered for the email Domain
    id str
    The provider-assigned unique ID for this managed resource.
    validation_status str
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    dnsValidationRecords List<Property Map>
    TXT and cname records to be registered for the email Domain
    id String
    The provider-assigned unique ID for this managed resource.
    validationStatus String
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED

    Look up Existing EmailDomain Resource

    Get an existing EmailDomain 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?: EmailDomainState, opts?: CustomResourceOptions): EmailDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        brand_id: Optional[str] = None,
        display_name: Optional[str] = None,
        dns_validation_records: Optional[Sequence[EmailDomainDnsValidationRecordArgs]] = None,
        domain: Optional[str] = None,
        user_name: Optional[str] = None,
        validation_status: Optional[str] = None) -> EmailDomain
    func GetEmailDomain(ctx *Context, name string, id IDInput, state *EmailDomainState, opts ...ResourceOption) (*EmailDomain, error)
    public static EmailDomain Get(string name, Input<string> id, EmailDomainState? state, CustomResourceOptions? opts = null)
    public static EmailDomain get(String name, Output<String> id, EmailDomainState 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:
    BrandId string
    Brand id of the email domain.
    DisplayName string
    Display name of the email domain.
    DnsValidationRecords List<EmailDomainDnsValidationRecord>
    TXT and cname records to be registered for the email Domain
    Domain string
    Mail domain to send from.
    UserName string
    User name of the email domain.
    ValidationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    BrandId string
    Brand id of the email domain.
    DisplayName string
    Display name of the email domain.
    DnsValidationRecords []EmailDomainDnsValidationRecordArgs
    TXT and cname records to be registered for the email Domain
    Domain string
    Mail domain to send from.
    UserName string
    User name of the email domain.
    ValidationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    brandId String
    Brand id of the email domain.
    displayName String
    Display name of the email domain.
    dnsValidationRecords List<EmailDomainDnsValidationRecord>
    TXT and cname records to be registered for the email Domain
    domain String
    Mail domain to send from.
    userName String
    User name of the email domain.
    validationStatus String
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    brandId string
    Brand id of the email domain.
    displayName string
    Display name of the email domain.
    dnsValidationRecords EmailDomainDnsValidationRecord[]
    TXT and cname records to be registered for the email Domain
    domain string
    Mail domain to send from.
    userName string
    User name of the email domain.
    validationStatus string
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    brand_id str
    Brand id of the email domain.
    display_name str
    Display name of the email domain.
    dns_validation_records Sequence[EmailDomainDnsValidationRecordArgs]
    TXT and cname records to be registered for the email Domain
    domain str
    Mail domain to send from.
    user_name str
    User name of the email domain.
    validation_status str
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
    brandId String
    Brand id of the email domain.
    displayName String
    Display name of the email domain.
    dnsValidationRecords List<Property Map>
    TXT and cname records to be registered for the email Domain
    domain String
    Mail domain to send from.
    userName String
    User name of the email domain.
    validationStatus String
    Status of the email domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED

    Supporting Types

    EmailDomainDnsValidationRecord, EmailDomainDnsValidationRecordArgs

    Expiration string
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    Fqdn string
    DNS record name
    RecordType string
    Record type can be TXT or cname
    Value string
    DNS record value
    Expiration string
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    Fqdn string
    DNS record name
    RecordType string
    Record type can be TXT or cname
    Value string
    DNS record value
    expiration String
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    fqdn String
    DNS record name
    recordType String
    Record type can be TXT or cname
    value String
    DNS record value
    expiration string
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    fqdn string
    DNS record name
    recordType string
    Record type can be TXT or cname
    value string
    DNS record value
    expiration str
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    fqdn str
    DNS record name
    record_type str
    Record type can be TXT or cname
    value str
    DNS record value
    expiration String
    DNS TXT record expiration

    Deprecated: This field has been removed in the newest go sdk version and has become noop

    fqdn String
    DNS record name
    recordType String
    Record type can be TXT or cname
    value String
    DNS record value

    Import

    $ pulumi import okta:index/emailDomain:EmailDomain example &#60;domain id&#62;

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
    pulumi/pulumi-okta