1. Packages
  2. Okta
  3. API Docs
  4. EmailSenderVerification
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

okta.EmailSenderVerification

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

    DEPRECATED use okta.Index.EmailDomainVerification instead.

    Verifies the email sender. The resource won’t be created if the email sender could not be verified.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const exampleEmailSender = new okta.EmailSender("exampleEmailSender", {
        fromName: "Paul Atreides",
        fromAddress: "no-reply@caladan.planet",
        subdomain: "mail",
    });
    const exampleEmailSenderVerification = new okta.EmailSenderVerification("exampleEmailSenderVerification", {senderId: okta_email_sender.valid.id});
    
    import pulumi
    import pulumi_okta as okta
    
    example_email_sender = okta.EmailSender("exampleEmailSender",
        from_name="Paul Atreides",
        from_address="no-reply@caladan.planet",
        subdomain="mail")
    example_email_sender_verification = okta.EmailSenderVerification("exampleEmailSenderVerification", sender_id=okta_email_sender["valid"]["id"])
    
    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.NewEmailSender(ctx, "exampleEmailSender", &okta.EmailSenderArgs{
    			FromName:    pulumi.String("Paul Atreides"),
    			FromAddress: pulumi.String("no-reply@caladan.planet"),
    			Subdomain:   pulumi.String("mail"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = okta.NewEmailSenderVerification(ctx, "exampleEmailSenderVerification", &okta.EmailSenderVerificationArgs{
    			SenderId: pulumi.Any(okta_email_sender.Valid.Id),
    		})
    		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 exampleEmailSender = new Okta.EmailSender("exampleEmailSender", new()
        {
            FromName = "Paul Atreides",
            FromAddress = "no-reply@caladan.planet",
            Subdomain = "mail",
        });
    
        var exampleEmailSenderVerification = new Okta.EmailSenderVerification("exampleEmailSenderVerification", new()
        {
            SenderId = okta_email_sender.Valid.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.EmailSender;
    import com.pulumi.okta.EmailSenderArgs;
    import com.pulumi.okta.EmailSenderVerification;
    import com.pulumi.okta.EmailSenderVerificationArgs;
    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 exampleEmailSender = new EmailSender("exampleEmailSender", EmailSenderArgs.builder()        
                .fromName("Paul Atreides")
                .fromAddress("no-reply@caladan.planet")
                .subdomain("mail")
                .build());
    
            var exampleEmailSenderVerification = new EmailSenderVerification("exampleEmailSenderVerification", EmailSenderVerificationArgs.builder()        
                .senderId(okta_email_sender.valid().id())
                .build());
    
        }
    }
    
    resources:
      exampleEmailSender:
        type: okta:EmailSender
        properties:
          fromName: Paul Atreides
          fromAddress: no-reply@caladan.planet
          subdomain: mail
      exampleEmailSenderVerification:
        type: okta:EmailSenderVerification
        properties:
          senderId: ${okta_email_sender.valid.id}
    

    Create EmailSenderVerification Resource

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

    Constructor syntax

    new EmailSenderVerification(name: string, args: EmailSenderVerificationArgs, opts?: CustomResourceOptions);
    @overload
    def EmailSenderVerification(resource_name: str,
                                args: EmailSenderVerificationArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailSenderVerification(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                sender_id: Optional[str] = None)
    func NewEmailSenderVerification(ctx *Context, name string, args EmailSenderVerificationArgs, opts ...ResourceOption) (*EmailSenderVerification, error)
    public EmailSenderVerification(string name, EmailSenderVerificationArgs args, CustomResourceOptions? opts = null)
    public EmailSenderVerification(String name, EmailSenderVerificationArgs args)
    public EmailSenderVerification(String name, EmailSenderVerificationArgs args, CustomResourceOptions options)
    
    type: okta:EmailSenderVerification
    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 EmailSenderVerificationArgs
    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 EmailSenderVerificationArgs
    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 EmailSenderVerificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailSenderVerificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailSenderVerificationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var emailSenderVerificationResource = new Okta.EmailSenderVerification("emailSenderVerificationResource", new()
    {
        SenderId = "string",
    });
    
    example, err := okta.NewEmailSenderVerification(ctx, "emailSenderVerificationResource", &okta.EmailSenderVerificationArgs{
    	SenderId: pulumi.String("string"),
    })
    
    var emailSenderVerificationResource = new EmailSenderVerification("emailSenderVerificationResource", EmailSenderVerificationArgs.builder()        
        .senderId("string")
        .build());
    
    email_sender_verification_resource = okta.EmailSenderVerification("emailSenderVerificationResource", sender_id="string")
    
    const emailSenderVerificationResource = new okta.EmailSenderVerification("emailSenderVerificationResource", {senderId: "string"});
    
    type: okta:EmailSenderVerification
    properties:
        senderId: string
    

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

    SenderId string
    Email sender ID.
    SenderId string
    Email sender ID.
    senderId String
    Email sender ID.
    senderId string
    Email sender ID.
    sender_id str
    Email sender ID.
    senderId String
    Email sender ID.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EmailSenderVerification Resource

    Get an existing EmailSenderVerification 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?: EmailSenderVerificationState, opts?: CustomResourceOptions): EmailSenderVerification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            sender_id: Optional[str] = None) -> EmailSenderVerification
    func GetEmailSenderVerification(ctx *Context, name string, id IDInput, state *EmailSenderVerificationState, opts ...ResourceOption) (*EmailSenderVerification, error)
    public static EmailSenderVerification Get(string name, Input<string> id, EmailSenderVerificationState? state, CustomResourceOptions? opts = null)
    public static EmailSenderVerification get(String name, Output<String> id, EmailSenderVerificationState 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:
    SenderId string
    Email sender ID.
    SenderId string
    Email sender ID.
    senderId String
    Email sender ID.
    senderId string
    Email sender ID.
    sender_id str
    Email sender ID.
    senderId String
    Email sender ID.

    Import

    This resource does not support importing.

    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.8.1 published on Thursday, Apr 18, 2024 by Pulumi