Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. CustomHostname
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.CustomHostname

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  exampleCustomHostname:
    type: cloudflare:CustomHostname
    name: example_custom_hostname
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      hostname: app.example.com
      ssl:
        bundle_method: ubiquitous
        certificate_authority: google
        cloudflare_branding: false
        custom_cert_bundle:
          - customCertificate: |2+
                    -----BEGIN CERTIFICATE-----
                    MIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...
                    -----END CERTIFICATE-----

            customKey: |2+
                    -----BEGIN PRIVATE KEY-----
                    MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...
                    -----END PRIVATE KEY-----

        custom_certificate: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n'
        custom_key: |2+
              -----BEGIN RSA PRIVATE KEY-----
              MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG
              dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn
              abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid
              tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py
              FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE
              ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb
              HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/
              axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb
              +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g
              +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv
              KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7
              9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo
              /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu
              iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9
              N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe
              VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB
              vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U
              lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR
              9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7
              mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX
              dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe
              PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS
              fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W
              qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T
              lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi
              -----END RSA PRIVATE KEY-----

        method: http
        settings:
          ciphers:
            - ECDHE-RSA-AES128-GCM-SHA256
            - AES128-SHA
          earlyHints: on
          http2: on
          minTlsVersion: '1.2'
          tls13: on
        type: dv
        wildcard: false
      customMetadata:
        foo: string

    Create CustomHostname Resource

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

    Constructor syntax

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

@overload
def CustomHostname(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   hostname: Optional[str] = None,
                   ssl: Optional[CustomHostnameSslArgs] = None,
                   zone_id: Optional[str] = None,
                   custom_metadata: Optional[Mapping[str, str]] = None,
                   custom_origin_server: Optional[str] = None,
                   custom_origin_sni: Optional[str] = None)
    func NewCustomHostname(ctx *Context, name string, args CustomHostnameArgs, opts ...ResourceOption) (*CustomHostname, error)
    public CustomHostname(string name, CustomHostnameArgs args, CustomResourceOptions? opts = null)
    public CustomHostname(String name, CustomHostnameArgs args)
public CustomHostname(String name, CustomHostnameArgs args, CustomResourceOptions options)

    type: cloudflare:CustomHostname
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 CustomHostnameArgs
    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 CustomHostnameArgs
    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 CustomHostnameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomHostnameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomHostnameArgs
    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 customHostnameResource = new Cloudflare.CustomHostname("customHostnameResource", new()
{
    Hostname = "string",
    Ssl = new Cloudflare.Inputs.CustomHostnameSslArgs
    {
        BundleMethod = "string",
        CertificateAuthority = "string",
        CloudflareBranding = false,
        CustomCertBundles = new[]
        {
            new Cloudflare.Inputs.CustomHostnameSslCustomCertBundleArgs
            {
                CustomCertificate = "string",
                CustomKey = "string",
            },
        },
        CustomCertificate = "string",
        CustomKey = "string",
        Method = "string",
        Settings = new Cloudflare.Inputs.CustomHostnameSslSettingsArgs
        {
            Ciphers = new[]
            {
                "string",
            },
            EarlyHints = "string",
            Http2 = "string",
            MinTlsVersion = "string",
            Tls13 = "string",
        },
        Type = "string",
        Wildcard = false,
    },
    ZoneId = "string",
    CustomMetadata = 
    {
        { "string", "string" },
    },
    CustomOriginServer = "string",
    CustomOriginSni = "string",
});

    example, err := cloudflare.NewCustomHostname(ctx, "customHostnameResource", &cloudflare.CustomHostnameArgs{
	Hostname: pulumi.String("string"),
	Ssl: &cloudflare.CustomHostnameSslArgs{
		BundleMethod:         pulumi.String("string"),
		CertificateAuthority: pulumi.String("string"),
		CloudflareBranding:   pulumi.Bool(false),
		CustomCertBundles: cloudflare.CustomHostnameSslCustomCertBundleArray{
			&cloudflare.CustomHostnameSslCustomCertBundleArgs{
				CustomCertificate: pulumi.String("string"),
				CustomKey:         pulumi.String("string"),
			},
		},
		CustomCertificate: pulumi.String("string"),
		CustomKey:         pulumi.String("string"),
		Method:            pulumi.String("string"),
		Settings: &cloudflare.CustomHostnameSslSettingsArgs{
			Ciphers: pulumi.StringArray{
				pulumi.String("string"),
			},
			EarlyHints:    pulumi.String("string"),
			Http2:         pulumi.String("string"),
			MinTlsVersion: pulumi.String("string"),
			Tls13:         pulumi.String("string"),
		},
		Type:     pulumi.String("string"),
		Wildcard: pulumi.Bool(false),
	},
	ZoneId: pulumi.String("string"),
	CustomMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CustomOriginServer: pulumi.String("string"),
	CustomOriginSni:    pulumi.String("string"),
})

    var customHostnameResource = new CustomHostname("customHostnameResource", CustomHostnameArgs.builder()
    .hostname("string")
    .ssl(CustomHostnameSslArgs.builder()
        .bundleMethod("string")
        .certificateAuthority("string")
        .cloudflareBranding(false)
        .customCertBundles(CustomHostnameSslCustomCertBundleArgs.builder()
            .customCertificate("string")
            .customKey("string")
            .build())
        .customCertificate("string")
        .customKey("string")
        .method("string")
        .settings(CustomHostnameSslSettingsArgs.builder()
            .ciphers("string")
            .earlyHints("string")
            .http2("string")
            .minTlsVersion("string")
            .tls13("string")
            .build())
        .type("string")
        .wildcard(false)
        .build())
    .zoneId("string")
    .customMetadata(Map.of("string", "string"))
    .customOriginServer("string")
    .customOriginSni("string")
    .build());

    custom_hostname_resource = cloudflare.CustomHostname("customHostnameResource",
    hostname="string",
    ssl={
        "bundle_method": "string",
        "certificate_authority": "string",
        "cloudflare_branding": False,
        "custom_cert_bundles": [{
            "custom_certificate": "string",
            "custom_key": "string",
        }],
        "custom_certificate": "string",
        "custom_key": "string",
        "method": "string",
        "settings": {
            "ciphers": ["string"],
            "early_hints": "string",
            "http2": "string",
            "min_tls_version": "string",
            "tls13": "string",
        },
        "type": "string",
        "wildcard": False,
    },
    zone_id="string",
    custom_metadata={
        "string": "string",
    },
    custom_origin_server="string",
    custom_origin_sni="string")

    const customHostnameResource = new cloudflare.CustomHostname("customHostnameResource", {
    hostname: "string",
    ssl: {
        bundleMethod: "string",
        certificateAuthority: "string",
        cloudflareBranding: false,
        customCertBundles: [{
            customCertificate: "string",
            customKey: "string",
        }],
        customCertificate: "string",
        customKey: "string",
        method: "string",
        settings: {
            ciphers: ["string"],
            earlyHints: "string",
            http2: "string",
            minTlsVersion: "string",
            tls13: "string",
        },
        type: "string",
        wildcard: false,
    },
    zoneId: "string",
    customMetadata: {
        string: "string",
    },
    customOriginServer: "string",
    customOriginSni: "string",
});

    type: cloudflare:CustomHostname
properties:
    customMetadata:
        string: string
    customOriginServer: string
    customOriginSni: string
    hostname: string
    ssl:
        bundleMethod: string
        certificateAuthority: string
        cloudflareBranding: false
        customCertBundles:
            - customCertificate: string
              customKey: string
        customCertificate: string
        customKey: string
        method: string
        settings:
            ciphers:
                - string
            earlyHints: string
            http2: string
            minTlsVersion: string
            tls13: string
        type: string
        wildcard: false
    zoneId: string

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

    Hostname string
    The custom hostname that will point to your hostname via CNAME.
    Ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    ZoneId string
    Identifier
    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.
    Ssl CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    ZoneId string
    Identifier
    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.
    ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    zoneId String
    Identifier
    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.
    ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    zoneId string
    Identifier
    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 str
    The custom hostname that will point to your hostname via CNAME.
    ssl CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    zone_id str
    Identifier
    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 String
    The custom hostname that will point to your hostname via CNAME.
    ssl Property Map
    SSL properties used when creating the custom hostname.
    zoneId String
    Identifier
    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.

    Outputs

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

    CreatedAt string
    This is the time the hostname was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    OwnershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    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.
    CreatedAt string
    This is the time the hostname was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    OwnershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    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.
    createdAt String
    This is the time the hostname was created.
    id String
    The provider-assigned unique ID for this managed resource.
    ownershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    ownershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    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.
    createdAt string
    This is the time the hostname was created.
    id string
    The provider-assigned unique ID for this managed resource.
    ownershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    ownershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    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.
    created_at str
    This is the time the hostname was created.
    id str
    The provider-assigned unique ID for this managed resource.
    ownership_verification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    ownership_verification_http CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    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.
    createdAt String
    This is the time the hostname was created.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.

    Look up Existing CustomHostname Resource

    Get an existing CustomHostname 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?: CustomHostnameState, opts?: CustomResourceOptions): CustomHostname
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        custom_metadata: Optional[Mapping[str, str]] = None,
        custom_origin_server: Optional[str] = None,
        custom_origin_sni: Optional[str] = None,
        hostname: Optional[str] = None,
        ownership_verification: Optional[CustomHostnameOwnershipVerificationArgs] = None,
        ownership_verification_http: Optional[CustomHostnameOwnershipVerificationHttpArgs] = None,
        ssl: Optional[CustomHostnameSslArgs] = None,
        status: Optional[str] = None,
        verification_errors: Optional[Sequence[str]] = None,
        zone_id: Optional[str] = None) -> CustomHostname
    func GetCustomHostname(ctx *Context, name string, id IDInput, state *CustomHostnameState, opts ...ResourceOption) (*CustomHostname, error)
    public static CustomHostname Get(string name, Input<string> id, CustomHostnameState? state, CustomResourceOptions? opts = null)
    public static CustomHostname get(String name, Output<String> id, CustomHostnameState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:CustomHostname    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:
    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.
    OwnershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    OwnershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    Ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    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
    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.
    OwnershipVerification CustomHostnameOwnershipVerificationArgs
    This is a record which can be placed to activate a hostname.
    OwnershipVerificationHttp CustomHostnameOwnershipVerificationHttpArgs
    This presents the token to be served by the given http url to activate a hostname.
    Ssl CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    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
    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.
    ownershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    ownershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    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
    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.
    ownershipVerification CustomHostnameOwnershipVerification
    This is a record which can be placed to activate a hostname.
    ownershipVerificationHttp CustomHostnameOwnershipVerificationHttp
    This presents the token to be served by the given http url to activate a hostname.
    ssl CustomHostnameSsl
    SSL properties used when creating the custom hostname.
    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
    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.
    ownership_verification CustomHostnameOwnershipVerificationArgs
    This is a record which can be placed to activate a hostname.
    ownership_verification_http CustomHostnameOwnershipVerificationHttpArgs
    This presents the token to be served by the given http url to activate a hostname.
    ssl CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    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
    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.
    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
    SSL properties used when creating the custom hostname.
    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

    Supporting Types

    CustomHostnameOwnershipVerification, CustomHostnameOwnershipVerificationArgs

    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.

    CustomHostnameOwnershipVerificationHttp, CustomHostnameOwnershipVerificationHttpArgs

    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.

    CustomHostnameSsl, CustomHostnameSslArgs

    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".
    CloudflareBranding bool
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    CustomCertBundles List<CustomHostnameSslCustomCertBundle>
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    CustomCertificate string
    If a custom uploaded certificate is used.
    CustomKey string
    The key for a custom uploaded certificate.
    Method string
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    Settings CustomHostnameSslSettings
    SSL specific settings.
    Type string
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    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".
    CloudflareBranding bool
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    CustomCertBundles []CustomHostnameSslCustomCertBundle
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    CustomCertificate string
    If a custom uploaded certificate is used.
    CustomKey string
    The key for a custom uploaded certificate.
    Method string
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    Settings CustomHostnameSslSettings
    SSL specific settings.
    Type string
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    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".
    cloudflareBranding Boolean
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    customCertBundles List<CustomHostnameSslCustomCertBundle>
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    customCertificate String
    If a custom uploaded certificate is used.
    customKey String
    The key for a custom uploaded certificate.
    method String
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    settings CustomHostnameSslSettings
    SSL specific settings.
    type String
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    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".
    cloudflareBranding boolean
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    customCertBundles CustomHostnameSslCustomCertBundle[]
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    customCertificate string
    If a custom uploaded certificate is used.
    customKey string
    The key for a custom uploaded certificate.
    method string
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    settings CustomHostnameSslSettings
    SSL specific settings.
    type string
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    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".
    cloudflare_branding bool
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    custom_cert_bundles Sequence[CustomHostnameSslCustomCertBundle]
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    custom_certificate str
    If a custom uploaded certificate is used.
    custom_key str
    The key for a custom uploaded certificate.
    method str
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    settings CustomHostnameSslSettings
    SSL specific settings.
    type str
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    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".
    cloudflareBranding Boolean
    Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true
    customCertBundles List<Property Map>
    Array of custom certificate and key pairs (1 or 2 pairs allowed)
    customCertificate String
    If a custom uploaded certificate is used.
    customKey String
    The key for a custom uploaded certificate.
    method String
    Domain control validation (DCV) method used for this hostname. Available values: "http", "txt", "email".
    settings Property Map
    SSL specific settings.
    type String
    Level of validation to be used for this hostname. Domain validation (dv) must be used. Available values: "dv".
    wildcard Boolean
    Indicates whether the certificate covers a wildcard.

    CustomHostnameSslCustomCertBundle, CustomHostnameSslCustomCertBundleArgs

    CustomCertificate string
    If a custom uploaded certificate is used.
    CustomKey string
    The key for a custom uploaded certificate.
    CustomCertificate string
    If a custom uploaded certificate is used.
    CustomKey string
    The key for a custom uploaded certificate.
    customCertificate String
    If a custom uploaded certificate is used.
    customKey String
    The key for a custom uploaded certificate.
    customCertificate string
    If a custom uploaded certificate is used.
    customKey string
    The key for a custom uploaded certificate.
    custom_certificate str
    If a custom uploaded certificate is used.
    custom_key str
    The key for a custom uploaded certificate.
    customCertificate String
    If a custom uploaded certificate is used.
    customKey String
    The key for a custom uploaded certificate.

    CustomHostnameSslSettings, CustomHostnameSslSettingsArgs

    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".

    Import

    $ pulumi import cloudflare:index/customHostname:CustomHostname example '<zone_id>/<custom_hostname_id>'

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

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare