1. Packages
  2. Auth0
  3. API Docs
  4. CustomDomainVerification
Auth0 v3.3.3 published on Monday, Jun 3, 2024 by Pulumi

auth0.CustomDomainVerification

Explore with Pulumi AI

auth0 logo
Auth0 v3.3.3 published on Monday, Jun 3, 2024 by Pulumi

    With Auth0, you can use a custom domain to maintain a consistent user experience. This is a three-step process; you must configure the custom domain in Auth0, then create a DNS record for the domain, then verify the DNS record in Auth0. This resource allows for automating the verification part of the process.

    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: CustomDomainVerificationInitArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomDomainVerification(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 custom_domain_id: Optional[str] = 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: auth0: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 CustomDomainVerificationInitArgs
    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.

    Example

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

    var customDomainVerificationResource = new Auth0.CustomDomainVerification("customDomainVerificationResource", new()
    {
        CustomDomainId = "string",
    });
    
    example, err := auth0.NewCustomDomainVerification(ctx, "customDomainVerificationResource", &auth0.CustomDomainVerificationArgs{
    	CustomDomainId: pulumi.String("string"),
    })
    
    var customDomainVerificationResource = new CustomDomainVerification("customDomainVerificationResource", CustomDomainVerificationArgs.builder()
        .customDomainId("string")
        .build());
    
    custom_domain_verification_resource = auth0.CustomDomainVerification("customDomainVerificationResource", custom_domain_id="string")
    
    const customDomainVerificationResource = new auth0.CustomDomainVerification("customDomainVerificationResource", {customDomainId: "string"});
    
    type: auth0:CustomDomainVerification
    properties:
        customDomainId: 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

    The CustomDomainVerification resource accepts the following input properties:

    CustomDomainId string
    ID of the custom domain resource.
    CustomDomainId string
    ID of the custom domain resource.
    customDomainId String
    ID of the custom domain resource.
    customDomainId string
    ID of the custom domain resource.
    custom_domain_id str
    ID of the custom domain resource.
    customDomainId String
    ID of the custom domain resource.

    Outputs

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

    CnameApiKey string
    Id string
    The provider-assigned unique ID for this managed resource.
    OriginDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    CnameApiKey string
    Id string
    The provider-assigned unique ID for this managed resource.
    OriginDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey String
    id String
    The provider-assigned unique ID for this managed resource.
    originDomainName String
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey string
    id string
    The provider-assigned unique ID for this managed resource.
    originDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cname_api_key str
    id str
    The provider-assigned unique ID for this managed resource.
    origin_domain_name str
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey String
    id String
    The provider-assigned unique ID for this managed resource.
    originDomainName String
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.

    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,
            cname_api_key: Optional[str] = None,
            custom_domain_id: Optional[str] = None,
            origin_domain_name: Optional[str] = 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)
    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:
    CnameApiKey string
    CustomDomainId string
    ID of the custom domain resource.
    OriginDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    CnameApiKey string
    CustomDomainId string
    ID of the custom domain resource.
    OriginDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey String
    customDomainId String
    ID of the custom domain resource.
    originDomainName String
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey string
    customDomainId string
    ID of the custom domain resource.
    originDomainName string
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cname_api_key str
    custom_domain_id str
    ID of the custom domain resource.
    origin_domain_name str
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.
    cnameApiKey String
    customDomainId String
    ID of the custom domain resource.
    originDomainName String
    The DNS name of the Auth0 origin server that handles traffic for the custom domain.

    Import

    You can import this resource using the custom domain ID.

    Example:

    $ pulumi import auth0:index/customDomainVerification:CustomDomainVerification my_custom_domain_verification "cd_XXXXXXXXXXXXXXXX"
    

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

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.3.3 published on Monday, Jun 3, 2024 by Pulumi