Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. CustomDomainVerification
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.CustomDomainVerification

Explore with Pulumi AI

propelauth logo
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

    Custom Domain Verification resource. This is for verifying a custom domain for Production or Staging.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as propelauth from "@pulumi/propelauth";

const myCustomDomain = new propelauth.CustomDomain("myCustomDomain", {
    environment: "Prod",
    domain: "example.com",
});
// AWS Route53 Example
const primary = new aws.index.Aws_route53_zone("primary", {name: "example.com"});
const txtRecordForPropelauth = new aws.index.Aws_route53_record("txtRecordForPropelauth", {
    zoneId: primary.zoneId,
    name: myCustomDomain.txtRecordKey,
    type: "TXT",
    ttl: 300,
    records: [myCustomDomain.txtRecordValue],
}, {
    dependsOn: [myCustomDomain],
});
const cnameRecordForPropelauth = new aws.index.Aws_route53_record("cnameRecordForPropelauth", {
    zoneId: primary.zoneId,
    name: myCustomDomain.cnameRecordKey,
    type: "CNAME",
    ttl: 300,
    records: [myCustomDomain.cnameRecordValue],
}, {
    dependsOn: [myCustomDomain],
});
// This resource will verify the domain once your DNS records have been set up. See the above
// for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource 
// to set up the DNS records.
const myCustomDomainVerification = new propelauth.CustomDomainVerification("myCustomDomainVerification", {
    environment: myCustomDomain.environment,
    domain: myCustomDomain.domain,
}, {
    dependsOn: [
        myCustomDomain,
        txtRecordForPropelauth,
        cnameRecordForPropelauth,
    ],
});

    import pulumi
import pulumi_aws as aws
import pulumi_propelauth as propelauth

my_custom_domain = propelauth.CustomDomain("myCustomDomain",
    environment="Prod",
    domain="example.com")
# AWS Route53 Example
primary = aws.index.Aws_route53_zone("primary", name=example.com)
txt_record_for_propelauth = aws.index.Aws_route53_record("txtRecordForPropelauth",
    zone_id=primary.zone_id,
    name=my_custom_domain.txt_record_key,
    type=TXT,
    ttl=300,
    records=[my_custom_domain.txt_record_value],
    opts = pulumi.ResourceOptions(depends_on=[my_custom_domain]))
cname_record_for_propelauth = aws.index.Aws_route53_record("cnameRecordForPropelauth",
    zone_id=primary.zone_id,
    name=my_custom_domain.cname_record_key,
    type=CNAME,
    ttl=300,
    records=[my_custom_domain.cname_record_value],
    opts = pulumi.ResourceOptions(depends_on=[my_custom_domain]))
# This resource will verify the domain once your DNS records have been set up. See the above
# for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource 
# to set up the DNS records.
my_custom_domain_verification = propelauth.CustomDomainVerification("myCustomDomainVerification",
    environment=my_custom_domain.environment,
    domain=my_custom_domain.domain,
    opts = pulumi.ResourceOptions(depends_on=[
            my_custom_domain,
            txt_record_for_propelauth,
            cname_record_for_propelauth,
        ]))

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/go/aws"
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/propelauth/propelauth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myCustomDomain, err := propelauth.NewCustomDomain(ctx, "myCustomDomain", &propelauth.CustomDomainArgs{
			Environment: pulumi.String("Prod"),
			Domain:      pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		// AWS Route53 Example
		primary, err := aws.NewAws_route53_zone(ctx, "primary", &aws.Aws_route53_zoneArgs{
			Name: "example.com",
		})
		if err != nil {
			return err
		}
		txtRecordForPropelauth, err := aws.NewAws_route53_record(ctx, "txtRecordForPropelauth", &aws.Aws_route53_recordArgs{
			ZoneId: primary.ZoneId,
			Name:   myCustomDomain.TxtRecordKey,
			Type:   "TXT",
			Ttl:    300,
			Records: pulumi.StringArray{
				myCustomDomain.TxtRecordValue,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			myCustomDomain,
		}))
		if err != nil {
			return err
		}
		cnameRecordForPropelauth, err := aws.NewAws_route53_record(ctx, "cnameRecordForPropelauth", &aws.Aws_route53_recordArgs{
			ZoneId: primary.ZoneId,
			Name:   myCustomDomain.CnameRecordKey,
			Type:   "CNAME",
			Ttl:    300,
			Records: pulumi.StringArray{
				myCustomDomain.CnameRecordValue,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			myCustomDomain,
		}))
		if err != nil {
			return err
		}
		// This resource will verify the domain once your DNS records have been set up. See the above
		// for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource
		// to set up the DNS records.
		_, err = propelauth.NewCustomDomainVerification(ctx, "myCustomDomainVerification", &propelauth.CustomDomainVerificationArgs{
			Environment: myCustomDomain.Environment,
			Domain:      myCustomDomain.Domain,
		}, pulumi.DependsOn([]pulumi.Resource{
			myCustomDomain,
			txtRecordForPropelauth,
			cnameRecordForPropelauth,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Propelauth = Pulumi.Propelauth;

return await Deployment.RunAsync(() => 
{
    var myCustomDomain = new Propelauth.CustomDomain("myCustomDomain", new()
    {
        Environment = "Prod",
        Domain = "example.com",
    });

    // AWS Route53 Example
    var primary = new Aws.Index.Aws_route53_zone("primary", new()
    {
        Name = "example.com",
    });

    var txtRecordForPropelauth = new Aws.Index.Aws_route53_record("txtRecordForPropelauth", new()
    {
        ZoneId = primary.ZoneId,
        Name = myCustomDomain.TxtRecordKey,
        Type = "TXT",
        Ttl = 300,
        Records = new[]
        {
            myCustomDomain.TxtRecordValue,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myCustomDomain,
        },
    });

    var cnameRecordForPropelauth = new Aws.Index.Aws_route53_record("cnameRecordForPropelauth", new()
    {
        ZoneId = primary.ZoneId,
        Name = myCustomDomain.CnameRecordKey,
        Type = "CNAME",
        Ttl = 300,
        Records = new[]
        {
            myCustomDomain.CnameRecordValue,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myCustomDomain,
        },
    });

    // This resource will verify the domain once your DNS records have been set up. See the above
    // for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource 
    // to set up the DNS records.
    var myCustomDomainVerification = new Propelauth.CustomDomainVerification("myCustomDomainVerification", new()
    {
        Environment = myCustomDomain.Environment,
        Domain = myCustomDomain.Domain,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myCustomDomain,
            txtRecordForPropelauth,
            cnameRecordForPropelauth,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.CustomDomain;
import com.pulumi.propelauth.CustomDomainArgs;
import com.pulumi.aws.aws_route53_zone;
import com.pulumi.aws.Aws_route53_zoneArgs;
import com.pulumi.aws.aws_route53_record;
import com.pulumi.aws.Aws_route53_recordArgs;
import com.pulumi.propelauth.CustomDomainVerification;
import com.pulumi.propelauth.CustomDomainVerificationArgs;
import com.pulumi.resources.CustomResourceOptions;
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 myCustomDomain = new CustomDomain("myCustomDomain", CustomDomainArgs.builder()
            .environment("Prod")
            .domain("example.com")
            .build());

        // AWS Route53 Example
        var primary = new Aws_route53_zone("primary", Aws_route53_zoneArgs.builder()
            .name("example.com")
            .build());

        var txtRecordForPropelauth = new Aws_route53_record("txtRecordForPropelauth", Aws_route53_recordArgs.builder()
            .zoneId(primary.zoneId())
            .name(myCustomDomain.txtRecordKey())
            .type("TXT")
            .ttl(300)
            .records(myCustomDomain.txtRecordValue())
            .build(), CustomResourceOptions.builder()
                .dependsOn(myCustomDomain)
                .build());

        var cnameRecordForPropelauth = new Aws_route53_record("cnameRecordForPropelauth", Aws_route53_recordArgs.builder()
            .zoneId(primary.zoneId())
            .name(myCustomDomain.cnameRecordKey())
            .type("CNAME")
            .ttl(300)
            .records(myCustomDomain.cnameRecordValue())
            .build(), CustomResourceOptions.builder()
                .dependsOn(myCustomDomain)
                .build());

        // This resource will verify the domain once your DNS records have been set up. See the above
        // for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource 
        // to set up the DNS records.
        var myCustomDomainVerification = new CustomDomainVerification("myCustomDomainVerification", CustomDomainVerificationArgs.builder()
            .environment(myCustomDomain.environment())
            .domain(myCustomDomain.domain())
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    myCustomDomain,
                    txtRecordForPropelauth,
                    cnameRecordForPropelauth)
                .build());

    }
}

    resources:
  myCustomDomain:
    type: propelauth:CustomDomain
    properties:
      environment: Prod
      domain: example.com
  # AWS Route53 Example
  primary:
    type: aws:aws_route53_zone
    properties:
      name: example.com
  txtRecordForPropelauth:
    type: aws:aws_route53_record
    properties:
      zoneId: ${primary.zoneId}
      name: ${myCustomDomain.txtRecordKey}
      type: TXT
      ttl: 300
      records:
        - ${myCustomDomain.txtRecordValue}
    options:
      dependsOn:
        - ${myCustomDomain}
  cnameRecordForPropelauth:
    type: aws:aws_route53_record
    properties:
      zoneId: ${primary.zoneId}
      name: ${myCustomDomain.cnameRecordKey}
      type: CNAME
      ttl: 300
      records:
        - ${myCustomDomain.cnameRecordValue}
    options:
      dependsOn:
        - ${myCustomDomain}
  # This resource will verify the domain once your DNS records have been set up. See the above
  # for how to do that with AWS Route 53 and the output of the "propelauth_custom_domain" resource 
  # to set up the DNS records.
  myCustomDomainVerification:
    type: propelauth:CustomDomainVerification
    properties:
      environment: ${myCustomDomain.environment}
      domain: ${myCustomDomain.domain}
    options:
      dependsOn:
        - ${myCustomDomain}
        - ${txtRecordForPropelauth}
        - ${cnameRecordForPropelauth}

    Create CustomDomainVerification Resource

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

    Constructor syntax

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

@overload
def CustomDomainVerification(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             domain: Optional[str] = None,
                             environment: Optional[str] = None,
                             timeouts: Optional[CustomDomainVerificationTimeoutsArgs] = None)
    func NewCustomDomainVerification(ctx *Context, name string, args CustomDomainVerificationArgs, opts ...ResourceOption) (*CustomDomainVerification, error)
    public CustomDomainVerification(string name, CustomDomainVerificationArgs args, CustomResourceOptions? opts = null)
    public CustomDomainVerification(String name, CustomDomainVerificationArgs args)
public CustomDomainVerification(String name, CustomDomainVerificationArgs args, CustomResourceOptions options)

    type: propelauth:CustomDomainVerification
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 CustomDomainVerificationArgs
    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 CustomDomainVerificationArgs
    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 CustomDomainVerificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDomainVerificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDomainVerificationArgs
    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 customDomainVerificationResource = new Propelauth.CustomDomainVerification("customDomainVerificationResource", new()
{
    Domain = "string",
    Environment = "string",
    Timeouts = new Propelauth.Inputs.CustomDomainVerificationTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := propelauth.NewCustomDomainVerification(ctx, "customDomainVerificationResource", &propelauth.CustomDomainVerificationArgs{
Domain: pulumi.String("string"),
Environment: pulumi.String("string"),
Timeouts: &.CustomDomainVerificationTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})

    var customDomainVerificationResource = new CustomDomainVerification("customDomainVerificationResource", CustomDomainVerificationArgs.builder()
    .domain("string")
    .environment("string")
    .timeouts(CustomDomainVerificationTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    custom_domain_verification_resource = propelauth.CustomDomainVerification("customDomainVerificationResource",
    domain="string",
    environment="string",
    timeouts={
        "create": "string",
        "update": "string",
    })

    const customDomainVerificationResource = new propelauth.CustomDomainVerification("customDomainVerificationResource", {
    domain: "string",
    environment: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: propelauth:CustomDomainVerification
properties:
    domain: string
    environment: string
    timeouts:
        create: string
        update: string

    CustomDomainVerification Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomDomainVerification resource accepts the following input properties:

    Domain string
    The domain to verify.
    Environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    Timeouts CustomDomainVerificationTimeouts
    Domain string
    The domain to verify.
    Environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    Timeouts CustomDomainVerificationTimeoutsArgs
    domain String
    The domain to verify.
    environment String
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeouts
    domain string
    The domain to verify.
    environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeouts
    domain str
    The domain to verify.
    environment str
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeoutsArgs
    domain String
    The domain to verify.
    environment String
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomDomainVerification 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 CustomDomainVerification Resource

    Get an existing CustomDomainVerification 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?: CustomDomainVerificationState, opts?: CustomResourceOptions): CustomDomainVerification
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain: Optional[str] = None,
        environment: Optional[str] = None,
        timeouts: Optional[CustomDomainVerificationTimeoutsArgs] = None) -> CustomDomainVerification
    func GetCustomDomainVerification(ctx *Context, name string, id IDInput, state *CustomDomainVerificationState, opts ...ResourceOption) (*CustomDomainVerification, error)
    public static CustomDomainVerification Get(string name, Input<string> id, CustomDomainVerificationState? state, CustomResourceOptions? opts = null)
    public static CustomDomainVerification get(String name, Output<String> id, CustomDomainVerificationState state, CustomResourceOptions options)
    resources:  _:    type: propelauth:CustomDomainVerification    get:      id: ${id}
    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:
    Domain string
    The domain to verify.
    Environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    Timeouts CustomDomainVerificationTimeouts
    Domain string
    The domain to verify.
    Environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    Timeouts CustomDomainVerificationTimeoutsArgs
    domain String
    The domain to verify.
    environment String
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeouts
    domain string
    The domain to verify.
    environment string
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeouts
    domain str
    The domain to verify.
    environment str
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts CustomDomainVerificationTimeoutsArgs
    domain String
    The domain to verify.
    environment String
    The environment for which you are configuring the custom domain. Accepted values are Staging, Prod.
    timeouts Property Map

    Supporting Types

    CustomDomainVerificationTimeouts, CustomDomainVerificationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Custom domains can be imported by which environment they are in

    $ pulumi import propelauth:index/customDomainVerification:CustomDomainVerification example Prod

    or

    $ pulumi import propelauth:index/customDomainVerification:CustomDomainVerification example Staging

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

    Package Details

    Repository
    propelauth propelauth/terraform-provider-propelauth
    License
    Notes
    This Pulumi package is based on the propelauth Terraform Provider.
    propelauth logo
    propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
    propelauth/terraform-provider-propelauth