1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. ProjectPagesSettings
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.ProjectPagesSettings

gitlab logo
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.ProjectPagesSettings resource manages project pages settings in GitLab.

    This is an experimental resource. By nature it doesn’t properly fit into how Terraform resources are meant to work.

    When you destroy the resource, you can control if pages settings are saved or not. Set keepSettingsOnDestroy to true (default) to save changes to pages settings. Set keepSettingsOnDestroy to false to reset the pages settings to its original values. The original values are saved in state when you create the resource. You can change the keepSettingsOnDestroy value before destroying the resource to control this behavior.

    Upstream API: GitLab REST API docs

    Create ProjectPagesSettings Resource

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

    Constructor syntax

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

@overload
def ProjectPagesSettings(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         project: Optional[str] = None,
                         force_https: Optional[bool] = None,
                         is_unique_domain_enabled: Optional[bool] = None,
                         keep_settings_on_destroy: Optional[bool] = None)
    func NewProjectPagesSettings(ctx *Context, name string, args ProjectPagesSettingsArgs, opts ...ResourceOption) (*ProjectPagesSettings, error)
    public ProjectPagesSettings(string name, ProjectPagesSettingsArgs args, CustomResourceOptions? opts = null)
    public ProjectPagesSettings(String name, ProjectPagesSettingsArgs args)
public ProjectPagesSettings(String name, ProjectPagesSettingsArgs args, CustomResourceOptions options)

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


    resource "gitlab_projectpagessettings" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProjectPagesSettingsArgs
    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 ProjectPagesSettingsArgs
    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 ProjectPagesSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectPagesSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectPagesSettingsArgs
    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 projectPagesSettingsResource = new GitLab.ProjectPagesSettings("projectPagesSettingsResource", new()
{
    Project = "string",
    ForceHttps = false,
    IsUniqueDomainEnabled = false,
    KeepSettingsOnDestroy = false,
});

    example, err := gitlab.NewProjectPagesSettings(ctx, "projectPagesSettingsResource", &gitlab.ProjectPagesSettingsArgs{
	Project:               pulumi.String("string"),
	ForceHttps:            pulumi.Bool(false),
	IsUniqueDomainEnabled: pulumi.Bool(false),
	KeepSettingsOnDestroy: pulumi.Bool(false),
})

    resource "gitlab_projectpagessettings" "projectPagesSettingsResource" {
  project                  = "string"
  force_https              = false
  is_unique_domain_enabled = false
  keep_settings_on_destroy = false
}

    var projectPagesSettingsResource = new ProjectPagesSettings("projectPagesSettingsResource", ProjectPagesSettingsArgs.builder()
    .project("string")
    .forceHttps(false)
    .isUniqueDomainEnabled(false)
    .keepSettingsOnDestroy(false)
    .build());

    project_pages_settings_resource = gitlab.ProjectPagesSettings("projectPagesSettingsResource",
    project="string",
    force_https=False,
    is_unique_domain_enabled=False,
    keep_settings_on_destroy=False)

    const projectPagesSettingsResource = new gitlab.ProjectPagesSettings("projectPagesSettingsResource", {
    project: "string",
    forceHttps: false,
    isUniqueDomainEnabled: false,
    keepSettingsOnDestroy: false,
});

    type: gitlab:ProjectPagesSettings
properties:
    forceHttps: false
    isUniqueDomainEnabled: false
    keepSettingsOnDestroy: false
    project: string

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

    Project string
    The project ID or path.
    ForceHttps bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    IsUniqueDomainEnabled bool
    Boolean indicating if a unique domain is enabled.
    KeepSettingsOnDestroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    Project string
    The project ID or path.
    ForceHttps bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    IsUniqueDomainEnabled bool
    Boolean indicating if a unique domain is enabled.
    KeepSettingsOnDestroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project string
    The project ID or path.
    force_https bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    is_unique_domain_enabled bool
    Boolean indicating if a unique domain is enabled.
    keep_settings_on_destroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project String
    The project ID or path.
    forceHttps Boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled Boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy Boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project string
    The project ID or path.
    forceHttps boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project str
    The project ID or path.
    force_https bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    is_unique_domain_enabled bool
    Boolean indicating if a unique domain is enabled.
    keep_settings_on_destroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project String
    The project ID or path.
    forceHttps Boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled Boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy Boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.

    Outputs

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

    Deployments List<Pulumi.GitLab.Outputs.ProjectPagesSettingsDeployment>
    List of current active deployments.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL to access the project pages.
    Deployments []ProjectPagesSettingsDeployment
    List of current active deployments.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL to access the project pages.
    deployments list(object)
    List of current active deployments.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL to access the project pages.
    deployments List<ProjectPagesSettingsDeployment>
    List of current active deployments.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL to access the project pages.
    deployments ProjectPagesSettingsDeployment[]
    List of current active deployments.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL to access the project pages.
    deployments Sequence[ProjectPagesSettingsDeployment]
    List of current active deployments.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The URL to access the project pages.
    deployments List<Property Map>
    List of current active deployments.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL to access the project pages.

    Look up Existing ProjectPagesSettings Resource

    Get an existing ProjectPagesSettings 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?: ProjectPagesSettingsState, opts?: CustomResourceOptions): ProjectPagesSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deployments: Optional[Sequence[ProjectPagesSettingsDeploymentArgs]] = None,
        force_https: Optional[bool] = None,
        is_unique_domain_enabled: Optional[bool] = None,
        keep_settings_on_destroy: Optional[bool] = None,
        project: Optional[str] = None,
        url: Optional[str] = None) -> ProjectPagesSettings
    func GetProjectPagesSettings(ctx *Context, name string, id IDInput, state *ProjectPagesSettingsState, opts ...ResourceOption) (*ProjectPagesSettings, error)
    public static ProjectPagesSettings Get(string name, Input<string> id, ProjectPagesSettingsState? state, CustomResourceOptions? opts = null)
    public static ProjectPagesSettings get(String name, Output<String> id, ProjectPagesSettingsState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:ProjectPagesSettings    get:      id: ${id}
    import {
  to = gitlab_projectpagessettings.example
  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:
    Deployments List<Pulumi.GitLab.Inputs.ProjectPagesSettingsDeployment>
    List of current active deployments.
    ForceHttps bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    IsUniqueDomainEnabled bool
    Boolean indicating if a unique domain is enabled.
    KeepSettingsOnDestroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    Project string
    The project ID or path.
    Url string
    The URL to access the project pages.
    Deployments []ProjectPagesSettingsDeploymentArgs
    List of current active deployments.
    ForceHttps bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    IsUniqueDomainEnabled bool
    Boolean indicating if a unique domain is enabled.
    KeepSettingsOnDestroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    Project string
    The project ID or path.
    Url string
    The URL to access the project pages.
    deployments list(object)
    List of current active deployments.
    force_https bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    is_unique_domain_enabled bool
    Boolean indicating if a unique domain is enabled.
    keep_settings_on_destroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project string
    The project ID or path.
    url string
    The URL to access the project pages.
    deployments List<ProjectPagesSettingsDeployment>
    List of current active deployments.
    forceHttps Boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled Boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy Boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project String
    The project ID or path.
    url String
    The URL to access the project pages.
    deployments ProjectPagesSettingsDeployment[]
    List of current active deployments.
    forceHttps boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project string
    The project ID or path.
    url string
    The URL to access the project pages.
    deployments Sequence[ProjectPagesSettingsDeploymentArgs]
    List of current active deployments.
    force_https bool
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    is_unique_domain_enabled bool
    Boolean indicating if a unique domain is enabled.
    keep_settings_on_destroy bool
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project str
    The project ID or path.
    url str
    The URL to access the project pages.
    deployments List<Property Map>
    List of current active deployments.
    forceHttps Boolean
    Boolean indicating if the project is set to force https. Requires externalHttps to be configured in the GitLab instance: https://docs.gitlab.com/administration/pages/#custom-domains-with-tls-support.
    isUniqueDomainEnabled Boolean
    Boolean indicating if a unique domain is enabled.
    keepSettingsOnDestroy Boolean
    Set to true if the pages settings should not be reset to their pre-terraform defaults on destroy.
    project String
    The project ID or path.
    url String
    The URL to access the project pages.

    Supporting Types

    ProjectPagesSettingsDeployment, ProjectPagesSettingsDeploymentArgs

    CreatedAt string
    Date the deployment was created.
    PathPrefix string
    The path prefix of the deployment when using parallel deployments.
    RootDirectory string
    The root directory of the deployment.
    Url string
    The URL of the deployment.
    CreatedAt string
    Date the deployment was created.
    PathPrefix string
    The path prefix of the deployment when using parallel deployments.
    RootDirectory string
    The root directory of the deployment.
    Url string
    The URL of the deployment.
    created_at string
    Date the deployment was created.
    path_prefix string
    The path prefix of the deployment when using parallel deployments.
    root_directory string
    The root directory of the deployment.
    url string
    The URL of the deployment.
    createdAt String
    Date the deployment was created.
    pathPrefix String
    The path prefix of the deployment when using parallel deployments.
    rootDirectory String
    The root directory of the deployment.
    url String
    The URL of the deployment.
    createdAt string
    Date the deployment was created.
    pathPrefix string
    The path prefix of the deployment when using parallel deployments.
    rootDirectory string
    The root directory of the deployment.
    url string
    The URL of the deployment.
    created_at str
    Date the deployment was created.
    path_prefix str
    The path prefix of the deployment when using parallel deployments.
    root_directory str
    The root directory of the deployment.
    url str
    The URL of the deployment.
    createdAt String
    Date the deployment was created.
    pathPrefix String
    The path prefix of the deployment when using parallel deployments.
    rootDirectory String
    The root directory of the deployment.
    url String
    The URL of the deployment.

    Import

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

    Importing using the CLI is supported with the following syntax:

    Gitlab project pages settings can be imported using the project ID, for example:

    $ pulumi import gitlab:index/projectPagesSettings:ProjectPagesSettings example 12345

    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 logo
    Viewing docs for GitLab v9.11.0
    published on Tuesday, Apr 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab
      Try Pulumi Cloud free. Your team will thank you.