Okta

Pulumi Official
Package maintained by Pulumi
v3.9.0 published on Monday, May 16, 2022 by Pulumi

EmailSender

This resource allows you to create and configure a custom email sender.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.EmailSender("example", new Okta.EmailSenderArgs
        {
            FromAddress = "no-reply@caladan.planet",
            FromName = "Paul Atreides",
            Subdomain = "mail",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewEmailSender(ctx, "example", &okta.EmailSenderArgs{
			FromAddress: pulumi.String("no-reply@caladan.planet"),
			FromName:    pulumi.String("Paul Atreides"),
			Subdomain:   pulumi.String("mail"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var example = new EmailSender("example", EmailSenderArgs.builder()        
            .fromAddress("no-reply@caladan.planet")
            .fromName("Paul Atreides")
            .subdomain("mail")
            .build());

        }
}
import pulumi
import pulumi_okta as okta

example = okta.EmailSender("example",
    from_address="no-reply@caladan.planet",
    from_name="Paul Atreides",
    subdomain="mail")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.EmailSender("example", {
    fromAddress: "no-reply@caladan.planet",
    fromName: "Paul Atreides",
    subdomain: "mail",
});
resources:
  example:
    type: okta:EmailSender
    properties:
      fromAddress: no-reply@caladan.planet
      fromName: Paul Atreides
      subdomain: mail

Create a EmailSender Resource

new EmailSender(name: string, args: EmailSenderArgs, opts?: CustomResourceOptions);
@overload
def EmailSender(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                from_address: Optional[str] = None,
                from_name: Optional[str] = None,
                subdomain: Optional[str] = None)
@overload
def EmailSender(resource_name: str,
                args: EmailSenderArgs,
                opts: Optional[ResourceOptions] = None)
func NewEmailSender(ctx *Context, name string, args EmailSenderArgs, opts ...ResourceOption) (*EmailSender, error)
public EmailSender(string name, EmailSenderArgs args, CustomResourceOptions? opts = null)
public EmailSender(String name, EmailSenderArgs args)
public EmailSender(String name, EmailSenderArgs args, CustomResourceOptions options)
type: okta:EmailSender
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

FromAddress string

Email address to send from.

FromName string

Name of sender.

Subdomain string

Mail domain to send from.

FromAddress string

Email address to send from.

FromName string

Name of sender.

Subdomain string

Mail domain to send from.

fromAddress String

Email address to send from.

fromName String

Name of sender.

subdomain String

Mail domain to send from.

fromAddress string

Email address to send from.

fromName string

Name of sender.

subdomain string

Mail domain to send from.

from_address str

Email address to send from.

from_name str

Name of sender.

subdomain str

Mail domain to send from.

fromAddress String

Email address to send from.

fromName String

Name of sender.

subdomain String

Mail domain to send from.

Outputs

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

DnsRecords List<EmailSenderDnsRecord>

TXT and CNAME records to be registered for the domain.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the sender (shows whether the sender is verified).

DnsRecords []EmailSenderDnsRecord

TXT and CNAME records to be registered for the domain.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the sender (shows whether the sender is verified).

dnsRecords List<EmailSenderDnsRecord>

TXT and CNAME records to be registered for the domain.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the sender (shows whether the sender is verified).

dnsRecords EmailSenderDnsRecord[]

TXT and CNAME records to be registered for the domain.

id string

The provider-assigned unique ID for this managed resource.

status string

Status of the sender (shows whether the sender is verified).

dns_records Sequence[EmailSenderDnsRecord]

TXT and CNAME records to be registered for the domain.

id str

The provider-assigned unique ID for this managed resource.

status str

Status of the sender (shows whether the sender is verified).

dnsRecords List<Property Map>

TXT and CNAME records to be registered for the domain.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the sender (shows whether the sender is verified).

Look up an Existing EmailSender Resource

Get an existing EmailSender 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?: EmailSenderState, opts?: CustomResourceOptions): EmailSender
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_records: Optional[Sequence[EmailSenderDnsRecordArgs]] = None,
        from_address: Optional[str] = None,
        from_name: Optional[str] = None,
        status: Optional[str] = None,
        subdomain: Optional[str] = None) -> EmailSender
func GetEmailSender(ctx *Context, name string, id IDInput, state *EmailSenderState, opts ...ResourceOption) (*EmailSender, error)
public static EmailSender Get(string name, Input<string> id, EmailSenderState? state, CustomResourceOptions? opts = null)
public static EmailSender get(String name, Output<String> id, EmailSenderState 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:
DnsRecords List<EmailSenderDnsRecordArgs>

TXT and CNAME records to be registered for the domain.

FromAddress string

Email address to send from.

FromName string

Name of sender.

Status string

Status of the sender (shows whether the sender is verified).

Subdomain string

Mail domain to send from.

DnsRecords []EmailSenderDnsRecordArgs

TXT and CNAME records to be registered for the domain.

FromAddress string

Email address to send from.

FromName string

Name of sender.

Status string

Status of the sender (shows whether the sender is verified).

Subdomain string

Mail domain to send from.

dnsRecords List<EmailSenderDnsRecordArgs>

TXT and CNAME records to be registered for the domain.

fromAddress String

Email address to send from.

fromName String

Name of sender.

status String

Status of the sender (shows whether the sender is verified).

subdomain String

Mail domain to send from.

dnsRecords EmailSenderDnsRecordArgs[]

TXT and CNAME records to be registered for the domain.

fromAddress string

Email address to send from.

fromName string

Name of sender.

status string

Status of the sender (shows whether the sender is verified).

subdomain string

Mail domain to send from.

dns_records Sequence[EmailSenderDnsRecordArgs]

TXT and CNAME records to be registered for the domain.

from_address str

Email address to send from.

from_name str

Name of sender.

status str

Status of the sender (shows whether the sender is verified).

subdomain str

Mail domain to send from.

dnsRecords List<Property Map>

TXT and CNAME records to be registered for the domain.

fromAddress String

Email address to send from.

fromName String

Name of sender.

status String

Status of the sender (shows whether the sender is verified).

subdomain String

Mail domain to send from.

Supporting Types

EmailSenderDnsRecord

Fqdn string

DNS record name.

RecordType string

Record type can be TXT or CNAME.

Value string

DNS verification value

Fqdn string

DNS record name.

RecordType string

Record type can be TXT or CNAME.

Value string

DNS verification value

fqdn String

DNS record name.

recordType String

Record type can be TXT or CNAME.

value String

DNS verification value

fqdn string

DNS record name.

recordType string

Record type can be TXT or CNAME.

value string

DNS verification value

fqdn str

DNS record name.

record_type str

Record type can be TXT or CNAME.

value str

DNS verification value

fqdn String

DNS record name.

recordType String

Record type can be TXT or CNAME.

value String

DNS verification value

Import

Custom email sender can be imported via the Okta ID.

 $ pulumi import okta:index/emailSender:EmailSender example &#60;sender id&#62;

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.