1. Packages
  2. Cloudflare
  3. API Docs
  4. CustomHostname
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

cloudflare.CustomHostname

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a Cloudflare custom hostname (also known as SSL for SaaS) resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.CustomHostname("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        hostname: "hostname.example.com",
        ssls: [{
            method: "txt",
        }],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.CustomHostname("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        hostname="hostname.example.com",
        ssls=[cloudflare.CustomHostnameSslArgs(
            method="txt",
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewCustomHostname(ctx, "example", &cloudflare.CustomHostnameArgs{
    			ZoneId:   pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			Hostname: pulumi.String("hostname.example.com"),
    			Ssls: cloudflare.CustomHostnameSslArray{
    				&cloudflare.CustomHostnameSslArgs{
    					Method: pulumi.String("txt"),
    				},
    			},
    		})
    		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 example = new Cloudflare.CustomHostname("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            Hostname = "hostname.example.com",
            Ssls = new[]
            {
                new Cloudflare.Inputs.CustomHostnameSslArgs
                {
                    Method = "txt",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CustomHostname;
    import com.pulumi.cloudflare.CustomHostnameArgs;
    import com.pulumi.cloudflare.inputs.CustomHostnameSslArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new CustomHostname("example", CustomHostnameArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .hostname("hostname.example.com")
                .ssls(CustomHostnameSslArgs.builder()
                    .method("txt")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:CustomHostname
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          hostname: hostname.example.com
          ssls:
            - method: txt
    

    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,
                       zone_id: Optional[str] = None,
                       custom_metadata: Optional[Mapping[str, str]] = None,
                       custom_origin_server: Optional[str] = None,
                       custom_origin_sni: Optional[str] = None,
                       ssls: Optional[Sequence[CustomHostnameSslArgs]] = None,
                       wait_for_ssl_pending_validation: Optional[bool] = 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.

    Example

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

    var customHostnameResource = new Cloudflare.CustomHostname("customHostnameResource", new()
    {
        Hostname = "string",
        ZoneId = "string",
        CustomMetadata = 
        {
            { "string", "string" },
        },
        CustomOriginServer = "string",
        CustomOriginSni = "string",
        Ssls = new[]
        {
            new Cloudflare.Inputs.CustomHostnameSslArgs
            {
                BundleMethod = "string",
                CertificateAuthority = "string",
                CustomCertificate = "string",
                CustomKey = "string",
                Method = "string",
                Settings = new[]
                {
                    new Cloudflare.Inputs.CustomHostnameSslSettingArgs
                    {
                        Ciphers = new[]
                        {
                            "string",
                        },
                        EarlyHints = "string",
                        Http2 = "string",
                        MinTlsVersion = "string",
                        Tls13 = "string",
                    },
                },
                Status = "string",
                Type = "string",
                ValidationErrors = new[]
                {
                    new Cloudflare.Inputs.CustomHostnameSslValidationErrorArgs
                    {
                        Message = "string",
                    },
                },
                ValidationRecords = new[]
                {
                    new Cloudflare.Inputs.CustomHostnameSslValidationRecordArgs
                    {
                        CnameName = "string",
                        CnameTarget = "string",
                        Emails = new[]
                        {
                            "string",
                        },
                        HttpBody = "string",
                        HttpUrl = "string",
                        TxtName = "string",
                        TxtValue = "string",
                    },
                },
                Wildcard = false,
            },
        },
        WaitForSslPendingValidation = false,
    });
    
    example, err := cloudflare.NewCustomHostname(ctx, "customHostnameResource", &cloudflare.CustomHostnameArgs{
    	Hostname: pulumi.String("string"),
    	ZoneId:   pulumi.String("string"),
    	CustomMetadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	CustomOriginServer: pulumi.String("string"),
    	CustomOriginSni:    pulumi.String("string"),
    	Ssls: cloudflare.CustomHostnameSslArray{
    		&cloudflare.CustomHostnameSslArgs{
    			BundleMethod:         pulumi.String("string"),
    			CertificateAuthority: pulumi.String("string"),
    			CustomCertificate:    pulumi.String("string"),
    			CustomKey:            pulumi.String("string"),
    			Method:               pulumi.String("string"),
    			Settings: cloudflare.CustomHostnameSslSettingArray{
    				&cloudflare.CustomHostnameSslSettingArgs{
    					Ciphers: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    					EarlyHints:    pulumi.String("string"),
    					Http2:         pulumi.String("string"),
    					MinTlsVersion: pulumi.String("string"),
    					Tls13:         pulumi.String("string"),
    				},
    			},
    			Status: pulumi.String("string"),
    			Type:   pulumi.String("string"),
    			ValidationErrors: cloudflare.CustomHostnameSslValidationErrorArray{
    				&cloudflare.CustomHostnameSslValidationErrorArgs{
    					Message: pulumi.String("string"),
    				},
    			},
    			ValidationRecords: cloudflare.CustomHostnameSslValidationRecordArray{
    				&cloudflare.CustomHostnameSslValidationRecordArgs{
    					CnameName:   pulumi.String("string"),
    					CnameTarget: pulumi.String("string"),
    					Emails: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    					HttpBody: pulumi.String("string"),
    					HttpUrl:  pulumi.String("string"),
    					TxtName:  pulumi.String("string"),
    					TxtValue: pulumi.String("string"),
    				},
    			},
    			Wildcard: pulumi.Bool(false),
    		},
    	},
    	WaitForSslPendingValidation: pulumi.Bool(false),
    })
    
    var customHostnameResource = new CustomHostname("customHostnameResource", CustomHostnameArgs.builder()
        .hostname("string")
        .zoneId("string")
        .customMetadata(Map.of("string", "string"))
        .customOriginServer("string")
        .customOriginSni("string")
        .ssls(CustomHostnameSslArgs.builder()
            .bundleMethod("string")
            .certificateAuthority("string")
            .customCertificate("string")
            .customKey("string")
            .method("string")
            .settings(CustomHostnameSslSettingArgs.builder()
                .ciphers("string")
                .earlyHints("string")
                .http2("string")
                .minTlsVersion("string")
                .tls13("string")
                .build())
            .status("string")
            .type("string")
            .validationErrors(CustomHostnameSslValidationErrorArgs.builder()
                .message("string")
                .build())
            .validationRecords(CustomHostnameSslValidationRecordArgs.builder()
                .cnameName("string")
                .cnameTarget("string")
                .emails("string")
                .httpBody("string")
                .httpUrl("string")
                .txtName("string")
                .txtValue("string")
                .build())
            .wildcard(false)
            .build())
        .waitForSslPendingValidation(false)
        .build());
    
    custom_hostname_resource = cloudflare.CustomHostname("customHostnameResource",
        hostname="string",
        zone_id="string",
        custom_metadata={
            "string": "string",
        },
        custom_origin_server="string",
        custom_origin_sni="string",
        ssls=[cloudflare.CustomHostnameSslArgs(
            bundle_method="string",
            certificate_authority="string",
            custom_certificate="string",
            custom_key="string",
            method="string",
            settings=[cloudflare.CustomHostnameSslSettingArgs(
                ciphers=["string"],
                early_hints="string",
                http2="string",
                min_tls_version="string",
                tls13="string",
            )],
            status="string",
            type="string",
            validation_errors=[cloudflare.CustomHostnameSslValidationErrorArgs(
                message="string",
            )],
            validation_records=[cloudflare.CustomHostnameSslValidationRecordArgs(
                cname_name="string",
                cname_target="string",
                emails=["string"],
                http_body="string",
                http_url="string",
                txt_name="string",
                txt_value="string",
            )],
            wildcard=False,
        )],
        wait_for_ssl_pending_validation=False)
    
    const customHostnameResource = new cloudflare.CustomHostname("customHostnameResource", {
        hostname: "string",
        zoneId: "string",
        customMetadata: {
            string: "string",
        },
        customOriginServer: "string",
        customOriginSni: "string",
        ssls: [{
            bundleMethod: "string",
            certificateAuthority: "string",
            customCertificate: "string",
            customKey: "string",
            method: "string",
            settings: [{
                ciphers: ["string"],
                earlyHints: "string",
                http2: "string",
                minTlsVersion: "string",
                tls13: "string",
            }],
            status: "string",
            type: "string",
            validationErrors: [{
                message: "string",
            }],
            validationRecords: [{
                cnameName: "string",
                cnameTarget: "string",
                emails: ["string"],
                httpBody: "string",
                httpUrl: "string",
                txtName: "string",
                txtValue: "string",
            }],
            wildcard: false,
        }],
        waitForSslPendingValidation: false,
    });
    
    type: cloudflare:CustomHostname
    properties:
        customMetadata:
            string: string
        customOriginServer: string
        customOriginSni: string
        hostname: string
        ssls:
            - bundleMethod: string
              certificateAuthority: string
              customCertificate: string
              customKey: string
              method: string
              settings:
                - ciphers:
                    - string
                  earlyHints: string
                  http2: string
                  minTlsVersion: string
                  tls13: string
              status: string
              type: string
              validationErrors:
                - message: string
              validationRecords:
                - cnameName: string
                  cnameTarget: string
                  emails:
                    - string
                  httpBody: string
                  httpUrl: string
                  txtName: string
                  txtValue: string
              wildcard: false
        waitForSslPendingValidation: 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

    The CustomHostname resource accepts the following input properties:

    Hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CustomMetadata Dictionary<string, string>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    CustomOriginServer string
    The custom origin server used for certificates.
    CustomOriginSni string
    The custom origin SNI used for certificates.
    Ssls List<CustomHostnameSsl>
    SSL properties used when creating the custom hostname.
    WaitForSslPendingValidation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    Hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CustomMetadata map[string]string
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    CustomOriginServer string
    The custom origin server used for certificates.
    CustomOriginSni string
    The custom origin SNI used for certificates.
    Ssls []CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    WaitForSslPendingValidation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    hostname String
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata Map<String,String>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer String
    The custom origin server used for certificates.
    customOriginSni String
    The custom origin SNI used for certificates.
    ssls List<CustomHostnameSsl>
    SSL properties used when creating the custom hostname.
    waitForSslPendingValidation Boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata {[key: string]: string}
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer string
    The custom origin server used for certificates.
    customOriginSni string
    The custom origin SNI used for certificates.
    ssls CustomHostnameSsl[]
    SSL properties used when creating the custom hostname.
    waitForSslPendingValidation boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    hostname str
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    custom_metadata Mapping[str, str]
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    custom_origin_server str
    The custom origin server used for certificates.
    custom_origin_sni str
    The custom origin SNI used for certificates.
    ssls Sequence[CustomHostnameSslArgs]
    SSL properties used when creating the custom hostname.
    wait_for_ssl_pending_validation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    hostname String
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata Map<String>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer String
    The custom origin server used for certificates.
    customOriginSni String
    The custom origin SNI used for certificates.
    ssls List<Property Map>
    SSL properties used when creating the custom hostname.
    waitForSslPendingValidation Boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnershipVerification Dictionary<string, string>
    OwnershipVerificationHttp Dictionary<string, string>
    Status string
    Status of the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnershipVerification map[string]string
    OwnershipVerificationHttp map[string]string
    Status string
    Status of the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    ownershipVerification Map<String,String>
    ownershipVerificationHttp Map<String,String>
    status String
    Status of the certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    ownershipVerification {[key: string]: string}
    ownershipVerificationHttp {[key: string]: string}
    status string
    Status of the certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    ownership_verification Mapping[str, str]
    ownership_verification_http Mapping[str, str]
    status str
    Status of the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    ownershipVerification Map<String>
    ownershipVerificationHttp Map<String>
    status String
    Status of the certificate.

    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,
            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[Mapping[str, str]] = None,
            ownership_verification_http: Optional[Mapping[str, str]] = None,
            ssls: Optional[Sequence[CustomHostnameSslArgs]] = None,
            status: Optional[str] = None,
            wait_for_ssl_pending_validation: Optional[bool] = 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)
    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:
    CustomMetadata Dictionary<string, string>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    CustomOriginServer string
    The custom origin server used for certificates.
    CustomOriginSni string
    The custom origin SNI used for certificates.
    Hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    OwnershipVerification Dictionary<string, string>
    OwnershipVerificationHttp Dictionary<string, string>
    Ssls List<CustomHostnameSsl>
    SSL properties used when creating the custom hostname.
    Status string
    Status of the certificate.
    WaitForSslPendingValidation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CustomMetadata map[string]string
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    CustomOriginServer string
    The custom origin server used for certificates.
    CustomOriginSni string
    The custom origin SNI used for certificates.
    Hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    OwnershipVerification map[string]string
    OwnershipVerificationHttp map[string]string
    Ssls []CustomHostnameSslArgs
    SSL properties used when creating the custom hostname.
    Status string
    Status of the certificate.
    WaitForSslPendingValidation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata Map<String,String>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer String
    The custom origin server used for certificates.
    customOriginSni String
    The custom origin SNI used for certificates.
    hostname String
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ownershipVerification Map<String,String>
    ownershipVerificationHttp Map<String,String>
    ssls List<CustomHostnameSsl>
    SSL properties used when creating the custom hostname.
    status String
    Status of the certificate.
    waitForSslPendingValidation Boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata {[key: string]: string}
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer string
    The custom origin server used for certificates.
    customOriginSni string
    The custom origin SNI used for certificates.
    hostname string
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ownershipVerification {[key: string]: string}
    ownershipVerificationHttp {[key: string]: string}
    ssls CustomHostnameSsl[]
    SSL properties used when creating the custom hostname.
    status string
    Status of the certificate.
    waitForSslPendingValidation boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    custom_metadata Mapping[str, str]
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    custom_origin_server str
    The custom origin server used for certificates.
    custom_origin_sni str
    The custom origin SNI used for certificates.
    hostname str
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ownership_verification Mapping[str, str]
    ownership_verification_http Mapping[str, str]
    ssls Sequence[CustomHostnameSslArgs]
    SSL properties used when creating the custom hostname.
    status str
    Status of the certificate.
    wait_for_ssl_pending_validation bool
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customMetadata Map<String>
    Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
    customOriginServer String
    The custom origin server used for certificates.
    customOriginSni String
    The custom origin SNI used for certificates.
    hostname String
    Hostname you intend to request a certificate for. Modifying this attribute will force creation of a new resource.
    ownershipVerification Map<String>
    ownershipVerificationHttp Map<String>
    ssls List<Property Map>
    SSL properties used when creating the custom hostname.
    status String
    Status of the certificate.
    waitForSslPendingValidation Boolean
    Whether to wait for a custom hostname SSL sub-object to reach status pending_validation during creation. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

    Supporting Types

    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
    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 List<CustomHostnameSslSetting>
    SSL/TLS settings for the certificate.
    Status string
    Type string
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    ValidationErrors List<CustomHostnameSslValidationError>
    ValidationRecords List<CustomHostnameSslValidationRecord>
    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
    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 []CustomHostnameSslSetting
    SSL/TLS settings for the certificate.
    Status string
    Type string
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    ValidationErrors []CustomHostnameSslValidationError
    ValidationRecords []CustomHostnameSslValidationRecord
    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
    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 List<CustomHostnameSslSetting>
    SSL/TLS settings for the certificate.
    status String
    type String
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    validationErrors List<CustomHostnameSslValidationError>
    validationRecords List<CustomHostnameSslValidationRecord>
    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
    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 CustomHostnameSslSetting[]
    SSL/TLS settings for the certificate.
    status string
    type string
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    validationErrors CustomHostnameSslValidationError[]
    validationRecords CustomHostnameSslValidationRecord[]
    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
    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 Sequence[CustomHostnameSslSetting]
    SSL/TLS settings for the certificate.
    status str
    type str
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    validation_errors Sequence[CustomHostnameSslValidationError]
    validation_records Sequence[CustomHostnameSslValidationRecord]
    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
    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 List<Property Map>
    SSL/TLS settings for the certificate.
    status String
    type String
    Level of validation to be used for this hostname. Available values: dv. Defaults to dv.
    validationErrors List<Property Map>
    validationRecords List<Property Map>
    wildcard Boolean
    Indicates whether the certificate covers a wildcard.

    CustomHostnameSslSetting, CustomHostnameSslSettingArgs

    Ciphers List<string>
    List of SSL/TLS ciphers to associate with this certificate.
    EarlyHints string
    Whether early hints should be supported. Available values: on, off.
    Http2 string
    Whether HTTP2 should be supported. Available values: on, off.
    MinTlsVersion string
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    Tls13 string
    Whether TLSv1.3 should be supported. Available values: on, off.
    Ciphers []string
    List of SSL/TLS ciphers to associate with this certificate.
    EarlyHints string
    Whether early hints should be supported. Available values: on, off.
    Http2 string
    Whether HTTP2 should be supported. Available values: on, off.
    MinTlsVersion string
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    Tls13 string
    Whether TLSv1.3 should be supported. Available values: on, off.
    ciphers List<String>
    List of SSL/TLS ciphers to associate with this certificate.
    earlyHints String
    Whether early hints should be supported. Available values: on, off.
    http2 String
    Whether HTTP2 should be supported. Available values: on, off.
    minTlsVersion String
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    tls13 String
    Whether TLSv1.3 should be supported. Available values: on, off.
    ciphers string[]
    List of SSL/TLS ciphers to associate with this certificate.
    earlyHints string
    Whether early hints should be supported. Available values: on, off.
    http2 string
    Whether HTTP2 should be supported. Available values: on, off.
    minTlsVersion string
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    tls13 string
    Whether TLSv1.3 should be supported. Available values: on, off.
    ciphers Sequence[str]
    List of SSL/TLS ciphers to associate with this certificate.
    early_hints str
    Whether early hints should be supported. Available values: on, off.
    http2 str
    Whether HTTP2 should be supported. Available values: on, off.
    min_tls_version str
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    tls13 str
    Whether TLSv1.3 should be supported. Available values: on, off.
    ciphers List<String>
    List of SSL/TLS ciphers to associate with this certificate.
    earlyHints String
    Whether early hints should be supported. Available values: on, off.
    http2 String
    Whether HTTP2 should be supported. Available values: on, off.
    minTlsVersion String
    Lowest version of TLS this certificate should support. Available values: 1.0, 1.1, 1.2, 1.3.
    tls13 String
    Whether TLSv1.3 should be supported. Available values: on, off.

    CustomHostnameSslValidationError, CustomHostnameSslValidationErrorArgs

    Message string
    Message string
    message String
    message string
    message String

    CustomHostnameSslValidationRecord, CustomHostnameSslValidationRecordArgs

    CnameName string
    CnameTarget string
    Emails List<string>
    HttpBody string
    HttpUrl string
    TxtName string
    TxtValue string
    CnameName string
    CnameTarget string
    Emails []string
    HttpBody string
    HttpUrl string
    TxtName string
    TxtValue string
    cnameName String
    cnameTarget String
    emails List<String>
    httpBody String
    httpUrl String
    txtName String
    txtValue String
    cnameName string
    cnameTarget string
    emails string[]
    httpBody string
    httpUrl string
    txtName string
    txtValue string
    cnameName String
    cnameTarget String
    emails List<String>
    httpBody String
    httpUrl String
    txtName String
    txtValue String

    Import

    $ pulumi import cloudflare:index/customHostname:CustomHostname example 1d5fdc9e88c8a8c4518b068cd94331fe/0d89c70d-ad9f-4843-b99f-6cc0252067e9
    

    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 v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi