Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. PagesDomain
GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.PagesDomain

Explore with Pulumi AI

GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.PagesDomain resource allows connecting custom domains and TLS certificates in GitLab Pages.

Upstream API: GitLab REST API docs

Create PagesDomain Resource

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

Constructor syntax

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

@overload
def PagesDomain(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain: Optional[str] = None,
                project: Optional[str] = None,
                auto_ssl_enabled: Optional[bool] = None,
                certificate: Optional[str] = None,
                expired: Optional[bool] = None,
                key: Optional[str] = None)
func NewPagesDomain(ctx *Context, name string, args PagesDomainArgs, opts ...ResourceOption) (*PagesDomain, error)
public PagesDomain(string name, PagesDomainArgs args, CustomResourceOptions? opts = null)
public PagesDomain(String name, PagesDomainArgs args)
public PagesDomain(String name, PagesDomainArgs args, CustomResourceOptions options)

type: gitlab:PagesDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PagesDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PagesDomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PagesDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PagesDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PagesDomainArgs
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 pagesDomainResource = new GitLab.PagesDomain("pagesDomainResource", new()
{
    Domain = "string",
    Project = "string",
    AutoSslEnabled = false,
    Certificate = "string",
    Expired = false,
    Key = "string",
});
Copy
example, err := gitlab.NewPagesDomain(ctx, "pagesDomainResource", &gitlab.PagesDomainArgs{
	Domain:         pulumi.String("string"),
	Project:        pulumi.String("string"),
	AutoSslEnabled: pulumi.Bool(false),
	Certificate:    pulumi.String("string"),
	Expired:        pulumi.Bool(false),
	Key:            pulumi.String("string"),
})
Copy
var pagesDomainResource = new PagesDomain("pagesDomainResource", PagesDomainArgs.builder()
    .domain("string")
    .project("string")
    .autoSslEnabled(false)
    .certificate("string")
    .expired(false)
    .key("string")
    .build());
Copy
pages_domain_resource = gitlab.PagesDomain("pagesDomainResource",
    domain="string",
    project="string",
    auto_ssl_enabled=False,
    certificate="string",
    expired=False,
    key="string")
Copy
const pagesDomainResource = new gitlab.PagesDomain("pagesDomainResource", {
    domain: "string",
    project: "string",
    autoSslEnabled: false,
    certificate: "string",
    expired: false,
    key: "string",
});
Copy
type: gitlab:PagesDomain
properties:
    autoSslEnabled: false
    certificate: string
    domain: string
    expired: false
    key: string
    project: string
Copy

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

Domain This property is required. string
The custom domain indicated by the user.
Project This property is required. string
The ID or URL-encoded path of the project owned by the authenticated user.
AutoSslEnabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
Certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
Expired bool
Whether the certificate is expired.
Key string
The certificate key in PEM format.
Domain This property is required. string
The custom domain indicated by the user.
Project This property is required. string
The ID or URL-encoded path of the project owned by the authenticated user.
AutoSslEnabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
Certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
Expired bool
Whether the certificate is expired.
Key string
The certificate key in PEM format.
domain This property is required. String
The custom domain indicated by the user.
project This property is required. String
The ID or URL-encoded path of the project owned by the authenticated user.
autoSslEnabled Boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate String
The certificate in PEM format with intermediates following in most specific to least specific order.
expired Boolean
Whether the certificate is expired.
key String
The certificate key in PEM format.
domain This property is required. string
The custom domain indicated by the user.
project This property is required. string
The ID or URL-encoded path of the project owned by the authenticated user.
autoSslEnabled boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
expired boolean
Whether the certificate is expired.
key string
The certificate key in PEM format.
domain This property is required. str
The custom domain indicated by the user.
project This property is required. str
The ID or URL-encoded path of the project owned by the authenticated user.
auto_ssl_enabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate str
The certificate in PEM format with intermediates following in most specific to least specific order.
expired bool
Whether the certificate is expired.
key str
The certificate key in PEM format.
domain This property is required. String
The custom domain indicated by the user.
project This property is required. String
The ID or URL-encoded path of the project owned by the authenticated user.
autoSslEnabled Boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate String
The certificate in PEM format with intermediates following in most specific to least specific order.
expired Boolean
Whether the certificate is expired.
key String
The certificate key in PEM format.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Url string
The URL for the given domain.
VerificationCode string
The verification code for the domain.
Verified bool
The certificate data.
Id string
The provider-assigned unique ID for this managed resource.
Url string
The URL for the given domain.
VerificationCode string
The verification code for the domain.
Verified bool
The certificate data.
id String
The provider-assigned unique ID for this managed resource.
url String
The URL for the given domain.
verificationCode String
The verification code for the domain.
verified Boolean
The certificate data.
id string
The provider-assigned unique ID for this managed resource.
url string
The URL for the given domain.
verificationCode string
The verification code for the domain.
verified boolean
The certificate data.
id str
The provider-assigned unique ID for this managed resource.
url str
The URL for the given domain.
verification_code str
The verification code for the domain.
verified bool
The certificate data.
id String
The provider-assigned unique ID for this managed resource.
url String
The URL for the given domain.
verificationCode String
The verification code for the domain.
verified Boolean
The certificate data.

Look up Existing PagesDomain Resource

Get an existing PagesDomain 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?: PagesDomainState, opts?: CustomResourceOptions): PagesDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_ssl_enabled: Optional[bool] = None,
        certificate: Optional[str] = None,
        domain: Optional[str] = None,
        expired: Optional[bool] = None,
        key: Optional[str] = None,
        project: Optional[str] = None,
        url: Optional[str] = None,
        verification_code: Optional[str] = None,
        verified: Optional[bool] = None) -> PagesDomain
func GetPagesDomain(ctx *Context, name string, id IDInput, state *PagesDomainState, opts ...ResourceOption) (*PagesDomain, error)
public static PagesDomain Get(string name, Input<string> id, PagesDomainState? state, CustomResourceOptions? opts = null)
public static PagesDomain get(String name, Output<String> id, PagesDomainState state, CustomResourceOptions options)
resources:  _:    type: gitlab:PagesDomain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutoSslEnabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
Certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
Domain string
The custom domain indicated by the user.
Expired bool
Whether the certificate is expired.
Key string
The certificate key in PEM format.
Project string
The ID or URL-encoded path of the project owned by the authenticated user.
Url string
The URL for the given domain.
VerificationCode string
The verification code for the domain.
Verified bool
The certificate data.
AutoSslEnabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
Certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
Domain string
The custom domain indicated by the user.
Expired bool
Whether the certificate is expired.
Key string
The certificate key in PEM format.
Project string
The ID or URL-encoded path of the project owned by the authenticated user.
Url string
The URL for the given domain.
VerificationCode string
The verification code for the domain.
Verified bool
The certificate data.
autoSslEnabled Boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate String
The certificate in PEM format with intermediates following in most specific to least specific order.
domain String
The custom domain indicated by the user.
expired Boolean
Whether the certificate is expired.
key String
The certificate key in PEM format.
project String
The ID or URL-encoded path of the project owned by the authenticated user.
url String
The URL for the given domain.
verificationCode String
The verification code for the domain.
verified Boolean
The certificate data.
autoSslEnabled boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate string
The certificate in PEM format with intermediates following in most specific to least specific order.
domain string
The custom domain indicated by the user.
expired boolean
Whether the certificate is expired.
key string
The certificate key in PEM format.
project string
The ID or URL-encoded path of the project owned by the authenticated user.
url string
The URL for the given domain.
verificationCode string
The verification code for the domain.
verified boolean
The certificate data.
auto_ssl_enabled bool
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate str
The certificate in PEM format with intermediates following in most specific to least specific order.
domain str
The custom domain indicated by the user.
expired bool
Whether the certificate is expired.
key str
The certificate key in PEM format.
project str
The ID or URL-encoded path of the project owned by the authenticated user.
url str
The URL for the given domain.
verification_code str
The verification code for the domain.
verified bool
The certificate data.
autoSslEnabled Boolean
Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
certificate String
The certificate in PEM format with intermediates following in most specific to least specific order.
domain String
The custom domain indicated by the user.
expired Boolean
Whether the certificate is expired.
key String
The certificate key in PEM format.
project String
The ID or URL-encoded path of the project owned by the authenticated user.
url String
The URL for the given domain.
verificationCode String
The verification code for the domain.
verified Boolean
The certificate data.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_pages_domain. For example:

terraform

import {

to = gitlab_pages_domain.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab pages domain can be imported using an id made up of projectId:domain without the http protocol, e.g.

$ pulumi import gitlab:index/pagesDomain:PagesDomain this 123:example.com
Copy

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

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.
GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab