Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getCustomHostname

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleCustomHostname = cloudflare.getCustomHostname({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    customHostnameId: "023e105f4ecef8ad9ca31a8372d0c353",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_custom_hostname = cloudflare.get_custom_hostname(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    custom_hostname_id="023e105f4ecef8ad9ca31a8372d0c353")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupCustomHostname(ctx, &cloudflare.LookupCustomHostnameArgs{
			ZoneId:           "023e105f4ecef8ad9ca31a8372d0c353",
			CustomHostnameId: pulumi.StringRef("023e105f4ecef8ad9ca31a8372d0c353"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleCustomHostname = Cloudflare.GetCustomHostname.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        CustomHostnameId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetCustomHostnameArgs;
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) {
        final var exampleCustomHostname = CloudflareFunctions.getCustomHostname(GetCustomHostnameArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .customHostnameId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

variables:
  exampleCustomHostname:
    fn::invoke:
      function: cloudflare:getCustomHostname
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        customHostnameId: 023e105f4ecef8ad9ca31a8372d0c353

Using getCustomHostname

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getCustomHostname(args: GetCustomHostnameArgs, opts?: InvokeOptions): Promise<GetCustomHostnameResult>
function getCustomHostnameOutput(args: GetCustomHostnameOutputArgs, opts?: InvokeOptions): Output<GetCustomHostnameResult>

def get_custom_hostname(custom_hostname_id: Optional[str] = None,
                        filter: Optional[GetCustomHostnameFilter] = None,
                        zone_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCustomHostnameResult
def get_custom_hostname_output(custom_hostname_id: Optional[pulumi.Input[str]] = None,
                        filter: Optional[pulumi.Input[GetCustomHostnameFilterArgs]] = None,
                        zone_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCustomHostnameResult]

func LookupCustomHostname(ctx *Context, args *LookupCustomHostnameArgs, opts ...InvokeOption) (*LookupCustomHostnameResult, error)
func LookupCustomHostnameOutput(ctx *Context, args *LookupCustomHostnameOutputArgs, opts ...InvokeOption) LookupCustomHostnameResultOutput

> Note: This function is named LookupCustomHostname in the Go SDK.

public static class GetCustomHostname 
{
    public static Task<GetCustomHostnameResult> InvokeAsync(GetCustomHostnameArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomHostnameResult> Invoke(GetCustomHostnameInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCustomHostnameResult> getCustomHostname(GetCustomHostnameArgs args, InvokeOptions options)
public static Output<GetCustomHostnameResult> getCustomHostname(GetCustomHostnameArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getCustomHostname:getCustomHostname
  arguments:
    # arguments dictionary

The following arguments are supported:

ZoneId string: Identifier
CustomHostnameId string: Identifier
Filter GetCustomHostnameFilter

ZoneId string: Identifier
CustomHostnameId string: Identifier
Filter GetCustomHostnameFilter

zoneId String: Identifier
customHostnameId String: Identifier
filter GetCustomHostnameFilter

zoneId string: Identifier
customHostnameId string: Identifier
filter GetCustomHostnameFilter

zone_id str: Identifier
custom_hostname_id str: Identifier
filter GetCustomHostnameFilter

zoneId String: Identifier
customHostnameId String: Identifier
filter Property Map

getCustomHostname Result

The following output properties are available:

CreatedAt string: This is the time the hostname was created.
CustomMetadata Dictionary<string, string>: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
CustomOriginServer string: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
CustomOriginSni string: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
Hostname string: The custom hostname that will point to your hostname via CNAME.
Id string: Identifier
OwnershipVerification GetCustomHostnameOwnershipVerification: This is a record which can be placed to activate a hostname.
OwnershipVerificationHttp GetCustomHostnameOwnershipVerificationHttp: This presents the token to be served by the given http url to activate a hostname.
Ssl GetCustomHostnameSsl
Status string: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
VerificationErrors List<string>: These are errors that were encountered while trying to activate a hostname.
ZoneId string: Identifier
CustomHostnameId string: Identifier
Filter GetCustomHostnameFilter

CreatedAt string: This is the time the hostname was created.
CustomMetadata map[string]string: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
CustomOriginServer string: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
CustomOriginSni string: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
Hostname string: The custom hostname that will point to your hostname via CNAME.
Id string: Identifier
OwnershipVerification GetCustomHostnameOwnershipVerification: This is a record which can be placed to activate a hostname.
OwnershipVerificationHttp GetCustomHostnameOwnershipVerificationHttp: This presents the token to be served by the given http url to activate a hostname.
Ssl GetCustomHostnameSsl
Status string: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
VerificationErrors []string: These are errors that were encountered while trying to activate a hostname.
ZoneId string: Identifier
CustomHostnameId string: Identifier
Filter GetCustomHostnameFilter

createdAt String: This is the time the hostname was created.
customMetadata Map<String,String>: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
customOriginServer String: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
customOriginSni String: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
hostname String: The custom hostname that will point to your hostname via CNAME.
id String: Identifier
ownershipVerification GetCustomHostnameOwnershipVerification: This is a record which can be placed to activate a hostname.
ownershipVerificationHttp GetCustomHostnameOwnershipVerificationHttp: This presents the token to be served by the given http url to activate a hostname.
ssl GetCustomHostnameSsl
status String: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
verificationErrors List<String>: These are errors that were encountered while trying to activate a hostname.
zoneId String: Identifier
customHostnameId String: Identifier
filter GetCustomHostnameFilter

createdAt string: This is the time the hostname was created.
customMetadata {[key: string]: string}: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
customOriginServer string: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
customOriginSni string: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
hostname string: The custom hostname that will point to your hostname via CNAME.
id string: Identifier
ownershipVerification GetCustomHostnameOwnershipVerification: This is a record which can be placed to activate a hostname.
ownershipVerificationHttp GetCustomHostnameOwnershipVerificationHttp: This presents the token to be served by the given http url to activate a hostname.
ssl GetCustomHostnameSsl
status string: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
verificationErrors string[]: These are errors that were encountered while trying to activate a hostname.
zoneId string: Identifier
customHostnameId string: Identifier
filter GetCustomHostnameFilter

created_at str: This is the time the hostname was created.
custom_metadata Mapping[str, str]: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
custom_origin_server str: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
custom_origin_sni str: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
hostname str: The custom hostname that will point to your hostname via CNAME.
id str: Identifier
ownership_verification GetCustomHostnameOwnershipVerification: This is a record which can be placed to activate a hostname.
ownership_verification_http GetCustomHostnameOwnershipVerificationHttp: This presents the token to be served by the given http url to activate a hostname.
ssl GetCustomHostnameSsl
status str: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
verification_errors Sequence[str]: These are errors that were encountered while trying to activate a hostname.
zone_id str: Identifier
custom_hostname_id str: Identifier
filter GetCustomHostnameFilter

createdAt String: This is the time the hostname was created.
customMetadata Map<String>: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
customOriginServer String: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
customOriginSni String: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':requesthostheader:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
hostname String: The custom hostname that will point to your hostname via CNAME.
id String: Identifier
ownershipVerification Property Map: This is a record which can be placed to activate a hostname.
ownershipVerificationHttp Property Map: This presents the token to be served by the given http url to activate a hostname.
ssl Property Map
status String: Status of the hostname's activation. Available values: "active", "pending", "activeredeploying", "moved", "pendingdeletion", "deleted", "pendingblocked", "pendingmigration", "pendingprovisioned", "testpending", "testactive", "testactiveapex", "testblocked", "test_failed", "provisioned", "blocked".
verificationErrors List<String>: These are errors that were encountered while trying to activate a hostname.
zoneId String: Identifier
customHostnameId String: Identifier
filter Property Map

Supporting Types

GetCustomHostnameFilter

Order string: Field to order hostnames by. Available values: "ssl", "ssl_status".
Direction string: Direction to order hostnames. Available values: "asc", "desc".
Hostname string: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
Id string: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
Ssl double: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

Order string: Field to order hostnames by. Available values: "ssl", "ssl_status".
Direction string: Direction to order hostnames. Available values: "asc", "desc".
Hostname string: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
Id string: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
Ssl float64: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

order String: Field to order hostnames by. Available values: "ssl", "ssl_status".
direction String: Direction to order hostnames. Available values: "asc", "desc".
hostname String: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
id String: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
ssl Double: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

order string: Field to order hostnames by. Available values: "ssl", "ssl_status".
direction string: Direction to order hostnames. Available values: "asc", "desc".
hostname string: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
id string: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
ssl number: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

order str: Field to order hostnames by. Available values: "ssl", "ssl_status".
direction str: Direction to order hostnames. Available values: "asc", "desc".
hostname str: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
id str: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
ssl float: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

order String: Field to order hostnames by. Available values: "ssl", "ssl_status".
direction String: Direction to order hostnames. Available values: "asc", "desc".
hostname String: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
id String: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
ssl Number: Whether to filter hostnames based on if they have SSL enabled. Available values: 0, 1.

GetCustomHostnameOwnershipVerification

Name string: DNS Name for record.
Type string: DNS Record type. Available values: "txt".
Value string: Content for the record.

Name string: DNS Name for record.
Type string: DNS Record type. Available values: "txt".
Value string: Content for the record.

name String: DNS Name for record.
type String: DNS Record type. Available values: "txt".
value String: Content for the record.

name string: DNS Name for record.
type string: DNS Record type. Available values: "txt".
value string: Content for the record.

name str: DNS Name for record.
type str: DNS Record type. Available values: "txt".
value str: Content for the record.

name String: DNS Name for record.
type String: DNS Record type. Available values: "txt".
value String: Content for the record.

GetCustomHostnameOwnershipVerificationHttp

HttpBody string: Token to be served.
HttpUrl string: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

HttpBody string: Token to be served.
HttpUrl string: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

httpBody String: Token to be served.
httpUrl String: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

httpBody string: Token to be served.
httpUrl string: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

http_body str: Token to be served.
http_url str: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

httpBody String: Token to be served.
httpUrl String: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

GetCustomHostnameSsl

BundleMethod string: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
CertificateAuthority string: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
CustomCertificate string: If a custom uploaded certificate is used.
CustomCsrId string: The identifier for the Custom CSR that was used.
CustomKey string: The key for a custom uploaded certificate.
ExpiresOn string: The time the custom certificate expires on.
Hosts List<string>: A list of Hostnames on a custom uploaded certificate.
Id string: Custom hostname SSL identifier tag.
Issuer string: The issuer on a custom uploaded certificate.
Method string: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
SerialNumber string: The serial number on a custom uploaded certificate.
Settings GetCustomHostnameSslSettings
Signature string: The signature on a custom uploaded certificate.
Status string: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
Type string: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
UploadedOn string: The time the custom certificate was uploaded.
ValidationErrors List<GetCustomHostnameSslValidationError>: Domain validation errors that have been received by the certificate authority (CA).
ValidationRecords List<GetCustomHostnameSslValidationRecord>
Wildcard bool: Indicates whether the certificate covers a wildcard.

BundleMethod string: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
CertificateAuthority string: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
CustomCertificate string: If a custom uploaded certificate is used.
CustomCsrId string: The identifier for the Custom CSR that was used.
CustomKey string: The key for a custom uploaded certificate.
ExpiresOn string: The time the custom certificate expires on.
Hosts []string: A list of Hostnames on a custom uploaded certificate.
Id string: Custom hostname SSL identifier tag.
Issuer string: The issuer on a custom uploaded certificate.
Method string: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
SerialNumber string: The serial number on a custom uploaded certificate.
Settings GetCustomHostnameSslSettings
Signature string: The signature on a custom uploaded certificate.
Status string: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
Type string: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
UploadedOn string: The time the custom certificate was uploaded.
ValidationErrors []GetCustomHostnameSslValidationError: Domain validation errors that have been received by the certificate authority (CA).
ValidationRecords []GetCustomHostnameSslValidationRecord
Wildcard bool: Indicates whether the certificate covers a wildcard.

bundleMethod String: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
certificateAuthority String: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
customCertificate String: If a custom uploaded certificate is used.
customCsrId String: The identifier for the Custom CSR that was used.
customKey String: The key for a custom uploaded certificate.
expiresOn String: The time the custom certificate expires on.
hosts List<String>: A list of Hostnames on a custom uploaded certificate.
id String: Custom hostname SSL identifier tag.
issuer String: The issuer on a custom uploaded certificate.
method String: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
serialNumber String: The serial number on a custom uploaded certificate.
settings GetCustomHostnameSslSettings
signature String: The signature on a custom uploaded certificate.
status String: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
type String: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
uploadedOn String: The time the custom certificate was uploaded.
validationErrors List<GetCustomHostnameSslValidationError>: Domain validation errors that have been received by the certificate authority (CA).
validationRecords List<GetCustomHostnameSslValidationRecord>
wildcard Boolean: Indicates whether the certificate covers a wildcard.

bundleMethod string: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
certificateAuthority string: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
customCertificate string: If a custom uploaded certificate is used.
customCsrId string: The identifier for the Custom CSR that was used.
customKey string: The key for a custom uploaded certificate.
expiresOn string: The time the custom certificate expires on.
hosts string[]: A list of Hostnames on a custom uploaded certificate.
id string: Custom hostname SSL identifier tag.
issuer string: The issuer on a custom uploaded certificate.
method string: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
serialNumber string: The serial number on a custom uploaded certificate.
settings GetCustomHostnameSslSettings
signature string: The signature on a custom uploaded certificate.
status string: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
type string: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
uploadedOn string: The time the custom certificate was uploaded.
validationErrors GetCustomHostnameSslValidationError[]: Domain validation errors that have been received by the certificate authority (CA).
validationRecords GetCustomHostnameSslValidationRecord[]
wildcard boolean: Indicates whether the certificate covers a wildcard.

bundle_method str: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
certificate_authority str: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
custom_certificate str: If a custom uploaded certificate is used.
custom_csr_id str: The identifier for the Custom CSR that was used.
custom_key str: The key for a custom uploaded certificate.
expires_on str: The time the custom certificate expires on.
hosts Sequence[str]: A list of Hostnames on a custom uploaded certificate.
id str: Custom hostname SSL identifier tag.
issuer str: The issuer on a custom uploaded certificate.
method str: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
serial_number str: The serial number on a custom uploaded certificate.
settings GetCustomHostnameSslSettings
signature str: The signature on a custom uploaded certificate.
status str: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
type str: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
uploaded_on str: The time the custom certificate was uploaded.
validation_errors Sequence[GetCustomHostnameSslValidationError]: Domain validation errors that have been received by the certificate authority (CA).
validation_records Sequence[GetCustomHostnameSslValidationRecord]
wildcard bool: Indicates whether the certificate covers a wildcard.

bundleMethod String: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Available values: "ubiquitous", "optimal", "force".
certificateAuthority String: The Certificate Authority that will issue the certificate Available values: "digicert", "google", "letsencrypt", "sslcom".
customCertificate String: If a custom uploaded certificate is used.
customCsrId String: The identifier for the Custom CSR that was used.
customKey String: The key for a custom uploaded certificate.
expiresOn String: The time the custom certificate expires on.
hosts List<String>: A list of Hostnames on a custom uploaded certificate.
id String: Custom hostname SSL identifier tag.
issuer String: The issuer on a custom uploaded certificate.
method String: Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
serialNumber String: The serial number on a custom uploaded certificate.
settings Property Map
signature String: The signature on a custom uploaded certificate.
status String: Status of the hostname's SSL certificates. Available values: "initializing", "pendingvalidation", "deleted", "pendingissuance", "pendingdeployment", "pendingdeletion", "pendingexpiration", "expired", "active", "initializingtimedout", "validationtimedout", "issuancetimedout", "deploymenttimedout", "deletiontimedout", "pendingcleanup", "stagingdeployment", "stagingactive", "deactivating", "inactive", "backupissued", "holdingdeployment".
type String: Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
uploadedOn String: The time the custom certificate was uploaded.
validationErrors List<Property Map>: Domain validation errors that have been received by the certificate authority (CA).
validationRecords List<Property Map>
wildcard Boolean: Indicates whether the certificate covers a wildcard.

GetCustomHostnameSslSettings

Ciphers List<string>: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
EarlyHints string: Whether or not Early Hints is enabled. Available values: "on", "off".
Http2 string: Whether or not HTTP2 is enabled. Available values: "on", "off".
MinTlsVersion string: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
Tls13 string: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

Ciphers []string: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
EarlyHints string: Whether or not Early Hints is enabled. Available values: "on", "off".
Http2 string: Whether or not HTTP2 is enabled. Available values: "on", "off".
MinTlsVersion string: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
Tls13 string: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

ciphers List<String>: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
earlyHints String: Whether or not Early Hints is enabled. Available values: "on", "off".
http2 String: Whether or not HTTP2 is enabled. Available values: "on", "off".
minTlsVersion String: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
tls13 String: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

ciphers string[]: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
earlyHints string: Whether or not Early Hints is enabled. Available values: "on", "off".
http2 string: Whether or not HTTP2 is enabled. Available values: "on", "off".
minTlsVersion string: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
tls13 string: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

ciphers Sequence[str]: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
early_hints str: Whether or not Early Hints is enabled. Available values: "on", "off".
http2 str: Whether or not HTTP2 is enabled. Available values: "on", "off".
min_tls_version str: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
tls13 str: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

ciphers List<String>: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
earlyHints String: Whether or not Early Hints is enabled. Available values: "on", "off".
http2 String: Whether or not HTTP2 is enabled. Available values: "on", "off".
minTlsVersion String: The minimum TLS version supported. Available values: "1.0", "1.1", "1.2", "1.3".
tls13 String: Whether or not TLS 1.3 is enabled. Available values: "on", "off".

GetCustomHostnameSslValidationError

Message string: A domain validation error.

Message string: A domain validation error.

message String: A domain validation error.

message string: A domain validation error.

message str: A domain validation error.

message String: A domain validation error.

GetCustomHostnameSslValidationRecord

Emails List<string>: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
HttpBody string: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
HttpUrl string: The url that will be checked during domain validation.
TxtName string: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
TxtValue string: The TXT record that the certificate authority (CA) will check during domain validation.

Emails []string: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
HttpBody string: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
HttpUrl string: The url that will be checked during domain validation.
TxtName string: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
TxtValue string: The TXT record that the certificate authority (CA) will check during domain validation.

emails List<String>: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
httpBody String: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
httpUrl String: The url that will be checked during domain validation.
txtName String: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
txtValue String: The TXT record that the certificate authority (CA) will check during domain validation.

emails string[]: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
httpBody string: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
httpUrl string: The url that will be checked during domain validation.
txtName string: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
txtValue string: The TXT record that the certificate authority (CA) will check during domain validation.

emails Sequence[str]: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
http_body str: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
http_url str: The url that will be checked during domain validation.
txt_name str: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
txt_value str: The TXT record that the certificate authority (CA) will check during domain validation.

emails List<String>: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
httpBody String: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
httpUrl String: The url that will be checked during domain validation.
txtName String: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
txtValue String: The TXT record that the certificate authority (CA) will check during domain validation.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getCustomHostname

On this page

On this page

Example Usage

Using getCustomHostname

getCustomHostname Result

Supporting Types

GetCustomHostnameFilter

GetCustomHostnameOwnershipVerification

GetCustomHostnameOwnershipVerificationHttp

GetCustomHostnameSsl

GetCustomHostnameSslSettings

GetCustomHostnameSslValidationError

GetCustomHostnameSslValidationRecord

Package Details

On this page

On this page