Class CustomDomain

With Auth0, you can use a custom domain to maintain a consistent user experience. This resource allows you to create and manage a custom domain within your Auth0 tenant.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
public MyStack()
{
    var myCustomDomain = new Auth0.CustomDomain("myCustomDomain", new Auth0.CustomDomainArgs
    {
        Domain = "auth.example.com",
        Type = "auth0_managed_certs",
        VerificationMethod = "txt",
    });
}

}

Inheritance

System.Object

Pulumi.Resource

Pulumi.CustomResource

CustomDomain

Inherited Members

Pulumi.CustomResource.Id

Pulumi.Resource.GetResourceType()

Pulumi.Resource.GetResourceName()

Pulumi.Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Auth0

Assembly: Pulumi.Auth0.dll

Syntax

public class CustomDomain : CustomResource

Constructors

CustomDomain(String, CustomDomainArgs, CustomResourceOptions)

Create a CustomDomain resource with the given unique name, arguments, and options.

Declaration

public CustomDomain(string name, CustomDomainArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
CustomDomainArgs	args	The arguments used to populate this resource's properties
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Domain

String. Name of the custom domain.

Declaration

public Output<string> Domain { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Primary

Boolean. Indicates whether or not this is a primary domain.

Declaration

public Output<bool> Primary { get; }

Property Value

Type	Description
Pulumi.Output<System.Boolean>

Status

String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.

Declaration

public Output<string> Status { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Type

String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Verification

List(Resource). Configuration settings for verification. For details, see Verification.

Declaration

public Output<CustomDomainVerification> Verification { get; }

Property Value

Type	Description
Pulumi.Output<CustomDomainVerification>

VerificationMethod

String. Domain verification method. Options include txt.

Declaration

public Output<string> VerificationMethod { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Methods

Get(String, Input<String>, CustomDomainState, CustomResourceOptions)

Get an existing CustomDomain resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static CustomDomain Get(string name, Input<string> id, CustomDomainState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Pulumi.Input<System.String>	id	The unique provider ID of the resource to lookup.
CustomDomainState	state	Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
CustomDomain