Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. PortalCustomDomain
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong
kong/terraform-provider-konnect

konnect.PortalCustomDomain

Explore with Pulumi AI

konnect logo
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong
kong/terraform-provider-konnect

    PortalCustomDomain Resource

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.PortalCustomDomain;
import com.pulumi.konnect.PortalCustomDomainArgs;
import com.pulumi.konnect.inputs.PortalCustomDomainSslArgs;
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 myPortalcustomdomain = new PortalCustomDomain("myPortalcustomdomain", PortalCustomDomainArgs.builder()
            .enabled(false)
            .hostname("...my_hostname...")
            .portalId("f32d905a-ed33-46a3-a093-d8f536af9a8a")
            .ssl(PortalCustomDomainSslArgs.builder()
                .custom_certificate("...my_custom_certificate...")
                .custom_private_key("...my_custom_private_key...")
                .domain_verification_method("custom_certificate")
                .build())
            .build());

    }
}

    resources:
  myPortalcustomdomain:
    type: konnect:PortalCustomDomain
    properties:
      enabled: false
      hostname: '...my_hostname...'
      portalId: f32d905a-ed33-46a3-a093-d8f536af9a8a
      ssl:
        custom_certificate: '...my_custom_certificate...'
        custom_private_key: '...my_custom_private_key...'
        domain_verification_method: custom_certificate

    Create PortalCustomDomain Resource

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

    Constructor syntax

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

@overload
def PortalCustomDomain(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       enabled: Optional[bool] = None,
                       hostname: Optional[str] = None,
                       portal_id: Optional[str] = None,
                       ssl: Optional[PortalCustomDomainSslArgs] = None)
    func NewPortalCustomDomain(ctx *Context, name string, args PortalCustomDomainArgs, opts ...ResourceOption) (*PortalCustomDomain, error)
    public PortalCustomDomain(string name, PortalCustomDomainArgs args, CustomResourceOptions? opts = null)
    public PortalCustomDomain(String name, PortalCustomDomainArgs args)
public PortalCustomDomain(String name, PortalCustomDomainArgs args, CustomResourceOptions options)

    type: konnect:PortalCustomDomain
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 PortalCustomDomainArgs
    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 PortalCustomDomainArgs
    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 PortalCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalCustomDomainArgs
    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 portalCustomDomainResource = new Konnect.PortalCustomDomain("portalCustomDomainResource", new()
{
    Enabled = false,
    Hostname = "string",
    PortalId = "string",
    Ssl = new Konnect.Inputs.PortalCustomDomainSslArgs
    {
        CustomCertificate = "string",
        CustomPrivateKey = "string",
        DomainVerificationMethod = "string",
        ValidationErrors = new[]
        {
            "string",
        },
        VerificationStatus = "string",
    },
});

    example, err := konnect.NewPortalCustomDomain(ctx, "portalCustomDomainResource", &konnect.PortalCustomDomainArgs{
	Enabled:  pulumi.Bool(false),
	Hostname: pulumi.String("string"),
	PortalId: pulumi.String("string"),
	Ssl: &konnect.PortalCustomDomainSslArgs{
		CustomCertificate:        pulumi.String("string"),
		CustomPrivateKey:         pulumi.String("string"),
		DomainVerificationMethod: pulumi.String("string"),
		ValidationErrors: pulumi.StringArray{
			pulumi.String("string"),
		},
		VerificationStatus: pulumi.String("string"),
	},
})

    var portalCustomDomainResource = new PortalCustomDomain("portalCustomDomainResource", PortalCustomDomainArgs.builder()
    .enabled(false)
    .hostname("string")
    .portalId("string")
    .ssl(PortalCustomDomainSslArgs.builder()
        .customCertificate("string")
        .customPrivateKey("string")
        .domainVerificationMethod("string")
        .validationErrors("string")
        .verificationStatus("string")
        .build())
    .build());

    portal_custom_domain_resource = konnect.PortalCustomDomain("portalCustomDomainResource",
    enabled=False,
    hostname="string",
    portal_id="string",
    ssl={
        "custom_certificate": "string",
        "custom_private_key": "string",
        "domain_verification_method": "string",
        "validation_errors": ["string"],
        "verification_status": "string",
    })

    const portalCustomDomainResource = new konnect.PortalCustomDomain("portalCustomDomainResource", {
    enabled: false,
    hostname: "string",
    portalId: "string",
    ssl: {
        customCertificate: "string",
        customPrivateKey: "string",
        domainVerificationMethod: "string",
        validationErrors: ["string"],
        verificationStatus: "string",
    },
});

    type: konnect:PortalCustomDomain
properties:
    enabled: false
    hostname: string
    portalId: string
    ssl:
        customCertificate: string
        customPrivateKey: string
        domainVerificationMethod: string
        validationErrors:
            - string
        verificationStatus: string

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

    Enabled bool
    Hostname string
    Requires replacement if changed.
    PortalId string
    The Portal identifier
    Ssl PortalCustomDomainSsl
    Requires replacement if changed.
    Enabled bool
    Hostname string
    Requires replacement if changed.
    PortalId string
    The Portal identifier
    Ssl PortalCustomDomainSslArgs
    Requires replacement if changed.
    enabled Boolean
    hostname String
    Requires replacement if changed.
    portalId String
    The Portal identifier
    ssl PortalCustomDomainSsl
    Requires replacement if changed.
    enabled boolean
    hostname string
    Requires replacement if changed.
    portalId string
    The Portal identifier
    ssl PortalCustomDomainSsl
    Requires replacement if changed.
    enabled bool
    hostname str
    Requires replacement if changed.
    portal_id str
    The Portal identifier
    ssl PortalCustomDomainSslArgs
    Requires replacement if changed.
    enabled Boolean
    hostname String
    Requires replacement if changed.
    portalId String
    The Portal identifier
    ssl Property Map
    Requires replacement if changed.

    Outputs

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

    CnameStatus string
    must be one of ["verified", "pending"]
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CnameStatus string
    must be one of ["verified", "pending"]
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus String
    must be one of ["verified", "pending"]
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus string
    must be one of ["verified", "pending"]
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    cname_status str
    must be one of ["verified", "pending"]
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus String
    must be one of ["verified", "pending"]
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing PortalCustomDomain Resource

    Get an existing PortalCustomDomain 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?: PortalCustomDomainState, opts?: CustomResourceOptions): PortalCustomDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cname_status: Optional[str] = None,
        created_at: Optional[str] = None,
        enabled: Optional[bool] = None,
        hostname: Optional[str] = None,
        portal_id: Optional[str] = None,
        ssl: Optional[PortalCustomDomainSslArgs] = None,
        updated_at: Optional[str] = None) -> PortalCustomDomain
    func GetPortalCustomDomain(ctx *Context, name string, id IDInput, state *PortalCustomDomainState, opts ...ResourceOption) (*PortalCustomDomain, error)
    public static PortalCustomDomain Get(string name, Input<string> id, PortalCustomDomainState? state, CustomResourceOptions? opts = null)
    public static PortalCustomDomain get(String name, Output<String> id, PortalCustomDomainState state, CustomResourceOptions options)
    resources:  _:    type: konnect:PortalCustomDomain    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:
    CnameStatus string
    must be one of ["verified", "pending"]
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Hostname string
    Requires replacement if changed.
    PortalId string
    The Portal identifier
    Ssl PortalCustomDomainSsl
    Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CnameStatus string
    must be one of ["verified", "pending"]
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Hostname string
    Requires replacement if changed.
    PortalId string
    The Portal identifier
    Ssl PortalCustomDomainSslArgs
    Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus String
    must be one of ["verified", "pending"]
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    hostname String
    Requires replacement if changed.
    portalId String
    The Portal identifier
    ssl PortalCustomDomainSsl
    Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus string
    must be one of ["verified", "pending"]
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    enabled boolean
    hostname string
    Requires replacement if changed.
    portalId string
    The Portal identifier
    ssl PortalCustomDomainSsl
    Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    cname_status str
    must be one of ["verified", "pending"]
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    enabled bool
    hostname str
    Requires replacement if changed.
    portal_id str
    The Portal identifier
    ssl PortalCustomDomainSslArgs
    Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    cnameStatus String
    must be one of ["verified", "pending"]
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    hostname String
    Requires replacement if changed.
    portalId String
    The Portal identifier
    ssl Property Map
    Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    PortalCustomDomainSsl, PortalCustomDomainSslArgs

    CustomCertificate string
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    CustomPrivateKey string
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    DomainVerificationMethod string
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    ValidationErrors List<string>
    VerificationStatus string
    must be one of ["verified", "pending", "error"]
    CustomCertificate string
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    CustomPrivateKey string
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    DomainVerificationMethod string
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    ValidationErrors []string
    VerificationStatus string
    must be one of ["verified", "pending", "error"]
    customCertificate String
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    customPrivateKey String
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    domainVerificationMethod String
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    validationErrors List<String>
    verificationStatus String
    must be one of ["verified", "pending", "error"]
    customCertificate string
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    customPrivateKey string
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    domainVerificationMethod string
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    validationErrors string[]
    verificationStatus string
    must be one of ["verified", "pending", "error"]
    custom_certificate str
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    custom_private_key str
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    domain_verification_method str
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    validation_errors Sequence[str]
    verification_status str
    must be one of ["verified", "pending", "error"]
    customCertificate String
    Custom certificate to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    customPrivateKey String
    Custom certificate private key to be used for the SSL termination. Only used when domainverificationmethod == "custom_certificate". Requires replacement if changed.
    domainVerificationMethod String
    must be one of ["custom_certificate", "http"]; Requires replacement if changed.
    validationErrors List<String>
    verificationStatus String
    must be one of ["verified", "pending", "error"]

    Import

    $ pulumi import konnect:index/portalCustomDomain:PortalCustomDomain my_konnect_portal_custom_domain "f32d905a-ed33-46a3-a093-d8f536af9a8a"

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

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong
    kong/terraform-provider-konnect